Skip to content

Commit

Permalink
Style Guide updates for Client, Server (#880)
Browse files Browse the repository at this point in the history
* Updates for Client, Server

* Add note on Server "listing"

* Use italics

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>

* Use italics

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>

* Use italics

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>

* Use italics

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>

* Update for style

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>

Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
  • Loading branch information
gilgongo and mcfnord authored Dec 25, 2022
1 parent 1ca7947 commit 80e8b4c
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions contribute/en/Style-and-Tone.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,17 @@ Jamulus is “Free and Open Source (FOSS)” (not “free software” or “open

“Fader” The UI that controls a channel. “Each fader has a mute button”, “The person’s fader” ,“Group faders together” (not “The person’s channel” or “Mute a Fader”, not “Slider” or “Volume control”)

“Person” A human connected to a server (may be on multiple channels). “People on the server”, “People who have muted themselves” (not “Musicians” or "Channels").
“Person” A human connected to a server (may be on multiple channels). We might say _people on the server_, or _people who have muted themselves_, rather than _Musicians_ or _Channels_.

“Server” The general term for the machine that a client connects to. Not to be confused with “Directory”.
"Client" When capitalised, this means an instance of Jamulus running in client mode, used to connect to Jamulus Servers.

Directory” The general term for a server that a client uses to get its list of public servers from. Use the term “Directory server” cautiously - it may be confusing in the presence of “Server”.
Server” When capitalized, refers to an instance of Jamulus running in server mode. When lowercase as _server_, this refers to the computer that runs the Server (e.g. _A Server running on an AWS server_). Not to be confused with Directory.

“Country/Region” Keep in mind that some areas of the world have a controversal (political) status. If possible, be generic and remain neutral. Instead of just saying country, use “Country/Region“ or “Location“.
“Directory” The term for a type of Server that a Client uses to get a list of Servers from. Avoid the use of the term _Directory Server_ because it may be confusing in the presence of _Server_ on its own.

“Country/Region” Keep in mind that some areas of the world have a controversial (political) status. If possible, be generic and remain neutral. Instead of just saying country, use _Country/Region_ or _Location_.

Registration: When a Server is configured in Registered mode, it will be _listed_ when successfully registered by a Directory. Note that if a Directory is full, a Registered Server will not be _listed_ because it has not been successfully _registered_.

## Units

Expand Down

0 comments on commit 80e8b4c

Please sign in to comment.