Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style Guide updates for Client, Server #880

Merged
merged 7 commits into from
Dec 25, 2022
Merged

Style Guide updates for Client, Server #880

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
946768b
Updates for Client, Server
gilgongo Dec 8, 2022
9ae91c4
Add note on Server "listing"
gilgongo Dec 18, 2022
da1019b
Use italics
gilgongo Dec 21, 2022
6a5f265
Use italics
gilgongo Dec 21, 2022
582934b
Use italics
gilgongo Dec 21, 2022
e1a97eb
Use italics
gilgongo Dec 21, 2022
4ff92f5
Update for style
gilgongo Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions contribute/en/Style-and-Tone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,11 @@ Jamulus is “Free and Open Source (FOSS)” (not “free software” or “open

“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").
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Servers have connections.

Copy link
Member Author

@gilgongo gilgongo Dec 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A connection would be a "fader" according to the guide. We wanted to use "person" because one person may have a number of faders on the server, and "fader" should be unambiguous because that's what you see in the UI (and it;s most likely to be what you're interested in eg, muting, volume, ordering).

gilgongo marked this conversation as resolved.
Show resolved Hide resolved

“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 capitalsed, this means an instance of Jamulus running in server mode. When lower case, this means the general term for the machine that runs the Server (eg "A Server running on an AWS server"). Not to be confused with “Directory”.
gilgongo marked this conversation as resolved.
Show resolved Hide resolved

“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” it may be confusing in the presence of “Server” on its own.
gilgongo marked this conversation as resolved.
Show resolved Hide resolved

“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“.
gilgongo marked this conversation as resolved.
Show resolved Hide resolved

Expand Down