]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
added some more guidance
authorAlan T. DeKok <aland@freeradius.org>
Tue, 29 Jul 2025 13:42:03 +0000 (09:42 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Tue, 29 Jul 2025 14:36:57 +0000 (10:36 -0400)
doc/antora/modules/developers/partials/terminology.adoc

index 4bf100fa4640111069ac63b23ca53716ea512994..273409ca7d980aaa472378d0f7d0203f228980f9 100644 (file)
@@ -20,7 +20,7 @@ The following tables indicate what are good or bad terms to use in our  document
 | mandatory                             | required, needed, must be present| Inclusive language.
 | user                                  | end-user                       | This term means the end-user or user clients that are accessing the network. These aren’t network clients like a NAS or proxy server that talk directly to the freeRADIUS server.
 | nases, NASes, Nases                   | NASs                          | NAS refers to network Access Server that may be a device or software. Many plural forms but need to standardize on one form. Currently set to NASs, but open to suggestion if we decide we want to go with NASes.
-| network user(s)                       | end-user(s) or network access clients(?)      | To differentiate between the RADIUS Server clients i.e. NAS, proxy server versus the end-user clients (windows machines, Macs).
+| network user(s)                       | end-user(s)                    | To differentiate between the RADIUS Server clients i.e. NAS, proxy server versus the end-user clients (windows machines, Macs).
 | clients                               | network clients, NAS           | Refers to any device that communicates directy with the RADIUS server.
 | should                                | must, required                 | Need to be More direct language to instruct user what they have to do. Should implies a suggestion and not necessarily a step that's required.
 | Network RADIUS, Network Radius        | InkBridge Networks             | Rebranding of documents.
@@ -36,12 +36,13 @@ The following tables indicate what are good or bad terms to use in our  document
 | stupid, stupidities    | nonsensical, problems, issues, senseless (if referring to an action, not person.) Other suggestions - lower intelligence threshold, unwanted behaviors, unexpected results, imprudences. | Stupid is a superfluous word and not needed.
 | crap, shit             | problems, issues               | Crap and shit are slang and hard to translate.
 | retarded               | not recommended, nonsensical   | Use inclusive language, this word precludes 'slower than average' reader.
-| hell                   | troublesome, give you issues   | Hell is hard to translate and alternative words can be used.
+| hell                   | troublesome, gives you issues   | Hell is hard to translate and alternative words can be used.
+| weenie                 | ineffectual, problematic, weak  | Weenie translates very differently into other languages and definitely not a good word to use.
 |===
 
 == Acronyms
 
-Add another table of technical terms and abbreviations here. Keep running across multiple spellings and capitalizations of some of the following:
+Add another table of technical terms and abbreviations here. Keep running across multiple spellings and capitalisations of some of the following:
 
 .Acronyms
 [options="headers, autowidth"]
@@ -50,6 +51,8 @@ Add another table of technical terms and abbreviations here. Keep running across
 | arp, arp              | ARP           | Standard way to reference protocol.
 | dns, Dns              | DNS           | Standard way to reference protocol.
 | eap, eap              | EAP           | Standard way to reference protocol.
+| ip                    | ip            | use ip when referencing a variable or a specific instance of an IP address in code or examples.
+| IP                    | IP            | use IP when referring to the Internet Protocol or networking standards.
 | tcp, Tcp, TCP         | TCP/IP        | Standard way to reference protocol.
 | TCPIP, TCPip, TcpIP   | TCP/IP        | Standard way to reference protocol.
 | Udp, udp              | UDP           | Standard way to reference protocol.