diff --git a/README.md b/README.md index bcf2f8031..df78792d5 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To edit an individual file, you can use the Github web interface or make a fork ### Viewing the website offline -You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run `jekyll serve`. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a_tools/po4a-create-all-targets.sh` before running `bundle exec jekyll serve` and viewing the site on `http://127.0.0.1:4000/`. Please ask in [Discussions](https://github.com/jamulussoftware/jamulus/discussions) for help with this if necessary. +You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run `jekyll serve`. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a-tools/po4a-create-all-targets.sh` before running `bundle exec jekyll serve` and viewing the site on `http://127.0.0.1:4000/`. Please ask in [Discussions](https://github.com/jamulussoftware/jamulus/discussions) for help with this if necessary. ## Formatting and style @@ -65,4 +65,4 @@ We collect changes to the English version of the site on a "next-release" branch - Translations should stay as close as possible to the original English text. If you see content in English that is incorrect or unclear, please do not attempt to correct or modify it in your translation, but rather make it known by [discussing it here](https://github.com/jamulussoftware/jamulus/discussions) so it can be corrected in the English files **first** and thus be applied to all other translations. -- Please make sure you are aware of what stage of the workflow we are currently at by monitoring the [project board](https://github.com/orgs/jamulussoftware/projects/2), and on the Discord (or Matrix) discussion channel that you will be invited to join. This is where relevant deadlines and information will be posted during the translation sprint. +- Please make sure you are aware of what stage of the workflow we are currently at by monitoring the [project board](https://github.com/orgs/jamulussoftware/projects/5/views/5), and on the Discord (or Matrix) discussion channel that you will be invited to join. This is where relevant deadlines and information will be posted during the translation sprint. diff --git a/contribute/en/Style-and-Tone.md b/contribute/en/Style-and-Tone.md index 6db1c9b7c..078565669 100644 --- a/contribute/en/Style-and-Tone.md +++ b/contribute/en/Style-and-Tone.md @@ -83,17 +83,19 @@ Refer to UI labels in inverted commas (eg 'click on the “mute” button') Jamulus is “Free and Open Source (FOSS)” (not “free software” or “open source”) -“Channel” The audio signal as part of a mix. “Mute a channel”, “Maximum number of channels”, “Group channels together” (not “Mute a person” because one person might be using multiple channels). +“Channel” The audio signal as part of a mix. “Mute a channel”, “Maximum number of channels”, “Group channels together”. -“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”) +"Fader" - the UI control that adjusts the channel volume heard in the mix. Not "volume slider", "volume control" or other term (adding the context of the mixer, if needed). -“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_. +“Person” When "channel" or "fader" isn't a good term (according to the above definitions), we refer to "people" connected to a server rather than "musicians" since (in English) the latter term does not imply singers. -“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_. +"Volume" Referring to how loud a channel is. Not "Level", "Gain" or other terms. + +“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". "Client" When capitalised, this means an instance of Jamulus running in client mode, used to connect to Jamulus Servers. -“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. +“Server” When capitalised, 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. “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.