From ac8103dffc10ee0a1080b0a48e25f7db6ed20ee6 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 20:47:03 +0100 Subject: [PATCH 01/19] Add new contributing file --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++---- README.md | 18 ++++++++++-------- 2 files changed, 56 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ee0fecd1..5dff9d2d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,47 @@ -# Contribute +# Contribute to the documentation +We really appreciate your support! Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody already raised an issue with the same topic. -Thanks for your support! -Please open an issue on github. More to come soon... -~~Please open a pull request on GitHub!~~ +If this is the case, please subscribe to the issue and explain your proposal. + +If that's not the case, please open a [new issue](https://github.com/jamulussoftware/jamuluswebsite/issues/new/choose), select which type of issue it is and describe your issue. + +If you want to open a Pull Request (after having described and discussed your proposal), have a look at the [Contribution page on the website](https://jamulus.io/wiki/Contribution). Keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is allright) with other changes and upload multiple changes in one bulk to jamulus.io. + +## I don't know GitHub. What do I need to know? +If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow this instructions: +1. Fork this repo (there's a fork button on the top right of the page) +2. Create a new branch from the up to date `changes` branch +3. Make your changes +4. If you did the changes offline, push the new branch into your repository +5. Submit your Pull Request (merge it to the `changes` branch), give a short description of your changes and link the issue you opened +6. Wait for a review and a merge. + +Hint (for git): **Do not merge your work** into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus Website repository. Create a new branch for your proposed changes. +If the `changes` branch is modified before submitting your request, keep the local `changes` branch in sync by pooling from the official one, merge the local changes branch into your working branch, resolve conflicts, push your changes and create the Pull Request. + +Please note that discussions should be kept in English. Don't be afraid, if you don't speak English fluently. You can use [DeepL](https://www.deepl.com) which might be able to translate your language to English. + +## Branches, Translation and development process + +We currently use multiple branches to ensure that translators know what to translate. Therefore have a look at the guideline below. + +After having discussed and agreed on changes you want to be integrated to jamulus.io, you should ask yourself some questions: + +## 0. Is the language of your content already online and existing? +No: Will discuss this later (since you introduce a new language). +Yes: +### 1. Be clear if your change needs translation +**No:** A fix which doesn't need to be translated (e.g. typo) --> Open a Pull Request to `release`. It will go live a few minutes after the PR is merged +**Yes:** A fix which needs to be translated (e.g. if you want to make a sentence or paragraph clearer) --> Commit to `changes` since others will need to translate it. It will be part of the next release. + +### 2. Be clear if a translation update is going on +You can see this if we ping the translators in a PR from changes to translate. + +**If yes:** only translate the changes of the pull request from changes to translation. If you find issues, start with 1 +**If no:** no need to care about the translate branch + +## Adding a new language + +1. Open an issue with the title [Translate] `yourLanguage` and say that you want to translate the homepage into your language. +2. If you start your new translation, follow the instructions to add a new language in the /README.md file on the changes branch. +3. Finally, open a PR to `translate` diff --git a/README.md b/README.md index 44dfbeb25..f668a4edd 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ # Jamulus Website -This is the home of the [Jamulus website](https://jamulus.io) and wiki. - -## Tech - -Built with Jekyll and Fox-CSS +This is the home of the [Jamulus website](https://jamulus.io). This page is to explain what Jamulus is and how to use it. ## Contribute and translation -Do you want to contribute to the Jamulus Wiki/Website? Please open an issue since we're currently discussing how to fasciliate contribution. ~~See the [CONTRIBUTING.md](CONTRIBUTING.md) file and the [contributing wiki entry](https://jamulus.io/wiki/Contribution).~~ +Do you want to contribute to the Jamulus Wiki/Website? Please open an issue see the [CONTRIBUTING.md](CONTRIBUTING.md) file. ## Adding pictures Unfortunately GitHub doesn't enable picture upload on the normal md editor. Therefore you can attempt to open an issue, upload your image, copy the link to the page you want to integrate it into and then don't submit the issue. See this answer on stack overflow: https://stackoverflow.com/a/26601810 ## Translating +**Before translating, please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.** + Translations are handled by the [Polyglot jekyll Plug-in](https://github.com/untra/polyglot). If you want to translate a file, you must first know where it is located on this repo: @@ -35,10 +33,14 @@ If you want to add a new language, you must follow the instructions on the polyg Have a look at the README.md files in these folders. +## Tech + +This site is built with Jekyll and Fox-CSS. + ## Contribute to the design/site structure -Since this page uses Jekyll, please have a look at the [jekyll documentation](https://jekyllrb.com/docs/). -This project uses the fox css framework. See the [FOX-CSS documentation](http://www.fox-css.com/documents/). +Since this page uses Jekyll, please have a look at the [Jekyll documentation](https://jekyllrb.com/docs/). +This project uses the FOX-CSS framework. See the [FOX-CSS documentation](http://www.fox-css.com/documents/). CSS files can be found in the assets/css folder. The \_layouts folder holds the main layouts for the page. More information can be found at the README.md files in (almost) every folder. From 02bdee15efc20bbb87c71b7eff8566c3321f86c2 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 21:04:14 +0100 Subject: [PATCH 02/19] Clarify branches --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5dff9d2d6..feca0cb37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,10 +10,10 @@ If you want to open a Pull Request (after having described and discussed your pr ## I don't know GitHub. What do I need to know? If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow this instructions: 1. Fork this repo (there's a fork button on the top right of the page) -2. Create a new branch from the up to date `changes` branch +2. Descide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found later in this file). Create a new branch from the up to date branch you chose 3. Make your changes 4. If you did the changes offline, push the new branch into your repository -5. Submit your Pull Request (merge it to the `changes` branch), give a short description of your changes and link the issue you opened +5. Submit your Pull Request, give a short description of your changes and link the issue you opened 6. Wait for a review and a merge. Hint (for git): **Do not merge your work** into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus Website repository. Create a new branch for your proposed changes. From 2077a3b9f7988b68ef98535e96044d8b099c83f1 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 21:43:52 +0100 Subject: [PATCH 03/19] Moved a bit to homepage --- CONTRIBUTING.md | 20 +++++++------------- wiki/en/en-Contribution.md | 23 ++++++++++++++++++----- 2 files changed, 25 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index feca0cb37..6199ab7a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,9 @@ # Contribute to the documentation -We really appreciate your support! Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody already raised an issue with the same topic. +We really appreciate your support! + +Please note that discussions should be kept in English. Don't be afraid, if you don't speak English fluently. You can use [DeepL](https://www.deepl.com) which might be able to translate your language to English. + +Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody already raised an issue with the same topic. If this is the case, please subscribe to the issue and explain your proposal. @@ -7,19 +11,9 @@ If that's not the case, please open a [new issue](https://github.com/jamulussoft If you want to open a Pull Request (after having described and discussed your proposal), have a look at the [Contribution page on the website](https://jamulus.io/wiki/Contribution). Keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is allright) with other changes and upload multiple changes in one bulk to jamulus.io. -## I don't know GitHub. What do I need to know? -If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow this instructions: -1. Fork this repo (there's a fork button on the top right of the page) -2. Descide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found later in this file). Create a new branch from the up to date branch you chose -3. Make your changes -4. If you did the changes offline, push the new branch into your repository -5. Submit your Pull Request, give a short description of your changes and link the issue you opened -6. Wait for a review and a merge. +Pull requests/issues for the website should have a title which looks like this: -Hint (for git): **Do not merge your work** into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus Website repository. Create a new branch for your proposed changes. -If the `changes` branch is modified before submitting your request, keep the local `changes` branch in sync by pooling from the official one, merge the local changes branch into your working branch, resolve conflicts, push your changes and create the Pull Request. - -Please note that discussions should be kept in English. Don't be afraid, if you don't speak English fluently. You can use [DeepL](https://www.deepl.com) which might be able to translate your language to English. +`[Tag (like Bug, Translation, etc.)][language code (e.g. en)] {short description of your changes}` ## Branches, Translation and development process diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index 979e71157..67d4abd33 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -8,18 +8,31 @@ permalink: "/wiki/Contribution" # Contributing to the Jamulus Project ## Jamulus Software -* If you want to contribute code, post your idea on [the developer forum](https://sourceforge.net/p/llcon/discussion/developerforum/) first so that it can be discussed before making a pull request (be sure to read main dev's [Volker's manifesto for contributions](https://github.com/corrados/jamulus/issues/596)) + +If you want to contribute code or have a feature request, [open an issue on GitHub](https://github.com/corrados/jamulus/issues/) (preferred) or [post your idea on the developer forum](https://sourceforge.net/p/llcon/discussion/developerforum/) if you don't have a GitHub account. This allows us to discuss the changes before e.g. making a pull request (be sure to read main dev's [Volker's manifesto for contributions on GitHub](https://github.com/corrados/jamulus/issues/596) and the [CONTRIBUTING file](https://github.com/corrados/jamulus/blob/master/CONTRIBUTING.md)) See the [Jamulus GitHub repo](https://github.com/corrados/jamulus) for further information. ## Jamulus Website -* If you find a mistake, typo or something out of date (in any language) on the website, you can [raise it as an issue here](https://github.com/jamulussoftware/jamuluswebsite/issues). +* If you find a mistake, typo or something out of date (in any language) on the website, you can [open an issue on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) or on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) on SourceForge. * If you think some documentation or information is missing or can be improved, post about that on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) so that it can be discussed first. -Pull requests for the website should look like this: +Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md) for the website and the [Website GitHub repo](https://github.com/jamulussoftware/jamuluswebsite) for further information. + +### I don't know GitHub. What do I need to know? + +**The following content is for the documentation on jamulus.io only, not for the Jamulus software!** + +If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow this instructions: -`[language code (e.g. en)] {short description of your changes}` on +1. Fork the repo (there's a fork button on the top right of the page) +2. Descide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose +3. Make your changes +4. If you did the changes offline, push the new branch into your repository +5. Submit your Pull Request, give a short description of your changes and link the issue you opened +6. Wait for a review and a merge -See the [Website GitHub repo](https://github.com/jamulussoftware/jamuluswebsite) for further information. +**Hint (for git):** *Do not merge your work* into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus Website repository. Create a new branch for your proposed changes. +If the `changes` branch is modified before submitting your request, keep the local `changes` branch in sync by pooling from the official one, merge the local changes branch into your working branch, resolve conflicts, push your changes and create the Pull Request. From 488bb9d09e50c9d5ea67086e7e33aa93505d074e Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 21:52:36 +0100 Subject: [PATCH 04/19] Review updates --- README.md | 2 +- wiki/en/en-Contribution.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f668a4edd..6985b87bc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is the home of the [Jamulus website](https://jamulus.io). This page is to e ## Contribute and translation -Do you want to contribute to the Jamulus Wiki/Website? Please open an issue see the [CONTRIBUTING.md](CONTRIBUTING.md) file. +Do you want to contribute to the Jamulus Wiki/Website? Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. ## Adding pictures Unfortunately GitHub doesn't enable picture upload on the normal md editor. Therefore you can attempt to open an issue, upload your image, copy the link to the page you want to integrate it into and then don't submit the issue. See this answer on stack overflow: https://stackoverflow.com/a/26601810 diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index 67d4abd33..461533fc9 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -25,14 +25,14 @@ Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamulu **The following content is for the documentation on jamulus.io only, not for the Jamulus software!** -If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow this instructions: +If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow those instructions: 1. Fork the repo (there's a fork button on the top right of the page) -2. Descide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose +2. Decide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose 3. Make your changes 4. If you did the changes offline, push the new branch into your repository 5. Submit your Pull Request, give a short description of your changes and link the issue you opened 6. Wait for a review and a merge -**Hint (for git):** *Do not merge your work* into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus Website repository. Create a new branch for your proposed changes. +**Hint (for git):** *Do not merge your work* into your local `changes` branch, only keep it in sync by pooling from the remote Jamulus website repository. Create a new branch for your proposed changes. If the `changes` branch is modified before submitting your request, keep the local `changes` branch in sync by pooling from the official one, merge the local changes branch into your working branch, resolve conflicts, push your changes and create the Pull Request. From ff94461d444114366753c85db5a221b8533c0b65 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 21:54:30 +0100 Subject: [PATCH 05/19] fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6199ab7a4..7c6fefe0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ Yes: ### 2. Be clear if a translation update is going on You can see this if we ping the translators in a PR from changes to translate. -**If yes:** only translate the changes of the pull request from changes to translation. If you find issues, start with 1 +**If yes:** only translate the changes of the Pull Request from changes to translation. If you find issues, start with 1 **If no:** no need to care about the translate branch ## Adding a new language From c56881bd8a45f323cb58e324316c712a01a1e081 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 21:58:01 +0100 Subject: [PATCH 06/19] Grammar --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c6fefe0c..097c8ebc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ We really appreciate your support! Please note that discussions should be kept in English. Don't be afraid, if you don't speak English fluently. You can use [DeepL](https://www.deepl.com) which might be able to translate your language to English. -Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody already raised an issue with the same topic. +Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody has raised an issue with the same topic. If this is the case, please subscribe to the issue and explain your proposal. From 957e2cfedf6e0485e00efb55ee723930a052cec9 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Mon, 7 Dec 2020 22:03:59 +0100 Subject: [PATCH 07/19] Add more translation services --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 097c8ebc5..893eaf233 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contribute to the documentation We really appreciate your support! -Please note that discussions should be kept in English. Don't be afraid, if you don't speak English fluently. You can use [DeepL](https://www.deepl.com) which might be able to translate your language to English. +Please note that discussions should be kept in English. If you don't speak English fluently you can use a reasonably good online translator (e.g. [DeepL](https://www.deepl.com), [Reverso](https://www.reverso.net/text_translation.aspx), ...) which might be able to translate your language to English. Please have a look at the [issues page on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) and check if anybody has raised an issue with the same topic. From 7852747abef70006f3998bc319abe058eaac19fc Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 21:10:11 +0100 Subject: [PATCH 08/19] fix a few issues --- CONTRIBUTING.md | 2 +- wiki/en/en-Contribution.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 893eaf233..7cee8b8fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ If this is the case, please subscribe to the issue and explain your proposal. If that's not the case, please open a [new issue](https://github.com/jamulussoftware/jamuluswebsite/issues/new/choose), select which type of issue it is and describe your issue. -If you want to open a Pull Request (after having described and discussed your proposal), have a look at the [Contribution page on the website](https://jamulus.io/wiki/Contribution). Keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is allright) with other changes and upload multiple changes in one bulk to jamulus.io. +If you want to open a Pull Request (after having described and discussed your proposal), have a look at the [Contribution page on the website](https://jamulus.io/wiki/Contribution). Keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is all right) with other changes and upload multiple changes in one bulk to jamulus.io. Pull requests/issues for the website should have a title which looks like this: diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index 461533fc9..c22cb1aa0 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -25,7 +25,7 @@ Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamulu **The following content is for the documentation on jamulus.io only, not for the Jamulus software!** -If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow those instructions: +If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow these instructions: 1. Fork the repo (there's a fork button on the top right of the page) 2. Decide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose From 3c2662c6320cd055c5f142dc74222963ae4a6fca Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 21:13:08 +0100 Subject: [PATCH 09/19] small fix --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7cee8b8fc..a409a5c5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ If this is the case, please subscribe to the issue and explain your proposal. If that's not the case, please open a [new issue](https://github.com/jamulussoftware/jamuluswebsite/issues/new/choose), select which type of issue it is and describe your issue. -If you want to open a Pull Request (after having described and discussed your proposal), have a look at the [Contribution page on the website](https://jamulus.io/wiki/Contribution). Keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is all right) with other changes and upload multiple changes in one bulk to jamulus.io. +If you want to open a Pull Request (after having described and discussed your proposal), keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is all right) with other changes and upload multiple changes in one bulk to jamulus.io. Pull requests/issues for the website should have a title which looks like this: From 90188653b104d10ba4ada9568d1f044483697442 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 21:15:43 +0100 Subject: [PATCH 10/19] Add github --- wiki/en/en-Contribution.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index c22cb1aa0..7e60a43f6 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -15,7 +15,7 @@ See the [Jamulus GitHub repo](https://github.com/corrados/jamulus) for further i ## Jamulus Website -* If you find a mistake, typo or something out of date (in any language) on the website, you can [open an issue on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) or on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) on SourceForge. +* If you find a mistake, typo or something out of date (in any language) on the website, you can [open an issue on GitHub](https://github.com/jamulussoftware/jamuluswebsite/issues) or, if you don't have a GitHub account on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) on SourceForge. * If you think some documentation or information is missing or can be improved, post about that on [the relevant discussion forum](https://sourceforge.net/p/llcon/discussion/) so that it can be discussed first. From 5a5d6c774dbf8ec418efc00eae6d4f9ab705f648 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 21:19:28 +0100 Subject: [PATCH 11/19] Update README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6985b87bc..da0dce00d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jamulus Website -This is the home of the [Jamulus website](https://jamulus.io). This page is to explain what Jamulus is and how to use it. +This is the home of the [Jamulus website](https://jamulus.io). The goal of this page is to explain what Jamulus is and how to use it. ## Contribute and translation @@ -11,25 +11,25 @@ Unfortunately GitHub doesn't enable picture upload on the normal md editor. Ther ## Translating -**Before translating, please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.** +**Before translating, please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file to get familiar with our translation process** -Translations are handled by the [Polyglot jekyll Plug-in](https://github.com/untra/polyglot). +Translations are handled by the [Polyglot Jekyll Plug-in](https://github.com/untra/polyglot). If you want to translate a file, you must first know where it is located on this repo: -- General translations especially for the wiki can be found in \_includes/wiki/yourlanguagecode folder. These files **must** be translated in order not to break the site. -- The homepage is located in the repo root and named [langcode]-index.html +- General translations (especially for the wiki) can be found in \_includes/wiki/yourlanguagecode folder. These files **must** be translated in order not to break the site. +- The homepage (https://jamulus.io/) is located in the repo root and named 1-[langcode]-index.html - The wiki content can be found in the wiki/ folder. Make sure to read the README.md file in the wiki/ folder. - The navigation and general translations can be found in the \_data/yourlanguagecode folder -To translate a file, please duplicate it and change the `lang:` attribute to the language you want to translate it to. If you want to translate an English page to German, you need to change the `lang: "en"` attribute to `lang: "de"`. This attribute can be found at the top of the file in the front matter (right at the top in between the `---`). Do not change the permalink attribute. It links pages with the same content but different languages and enables polyglot to know which page to change to if you change the language via the language picker. +To translate a file, please duplicate it and change the `lang:` attribute to the language you want to translate it to. If you want to translate an English page to German, you need to change the `lang: "en"` attribute to `lang: "de"`. This attribute can be found at the top of the file in the front matter (right at the top in between the `---`). Do not change the permalink attribute (It internally links pages with the same content but different languages and enables polyglot to know which page to change to if you change the language via the language picker.) ### Adding a new language If you want to add a new language, you must follow the instructions on the polyglot site and add the folders/files. - Make sure to add your language to the \_config.yml file (in the languages array.) - At least, the main includes for the wiki (see \_includes/wiki/) have to be translated. -- The navigation and general site wide strings (see the \_data/ folder) and the homepage (see the 1-index.html file in the root of this repo) should be translated. +- The navigation and general site-wide strings (see the \_data/ folder) and the homepage (see the 1-index.html file in the root of this repo) should be translated. Have a look at the README.md files in these folders. From 7b419bc48573dfc41196819643e0bc887f3374b1 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 22:08:14 +0100 Subject: [PATCH 12/19] @ignotus666 changes --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a409a5c5b..e51b5de24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ If this is the case, please subscribe to the issue and explain your proposal. If that's not the case, please open a [new issue](https://github.com/jamulussoftware/jamuluswebsite/issues/new/choose), select which type of issue it is and describe your issue. -If you want to open a Pull Request (after having described and discussed your proposal), keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is all right) with other changes and upload multiple changes in one bulk to jamulus.io. +If you want to open a Pull Request (after having described and discussed your proposal), keep in mind that your changes (if they are not just typos) might have to wait until everything is translated. We will bundle them (if everything is all right) with any other changes and upload all of them as a combined Pull Request to jamulus.io. Pull requests/issues for the website should have a title which looks like this: From 959f85e9bd7925bf3d6dba3784f1c31505783cd2 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Dec 2020 22:13:57 +0100 Subject: [PATCH 13/19] Wording --- wiki/en/en-Contribution.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index 7e60a43f6..9d15fe870 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -25,12 +25,12 @@ Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamulu **The following content is for the documentation on jamulus.io only, not for the Jamulus software!** -If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then care about your changes. If you want to do the changes on your own and open a Pull Request, follow these instructions: +If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then take care of your changes. If you want to do the changes on your own and open a Pull Request, follow these instructions: -1. Fork the repo (there's a fork button on the top right of the page) -2. Decide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose +1. Fork the repo (there's a fork button on the top right of the GitHub page) +2. Decide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch; more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose 3. Make your changes -4. If you did the changes offline, push the new branch into your repository +4. If you did the changes offline, push the new branch to your repository 5. Submit your Pull Request, give a short description of your changes and link the issue you opened 6. Wait for a review and a merge From 024a886b00a78bbc503706f960881ad943a272af Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Fri, 18 Dec 2020 22:09:15 +0100 Subject: [PATCH 14/19] ignotus rechnet --- wiki/en/en-Contribution.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki/en/en-Contribution.md b/wiki/en/en-Contribution.md index 9d15fe870..107c6dfe5 100644 --- a/wiki/en/en-Contribution.md +++ b/wiki/en/en-Contribution.md @@ -28,7 +28,7 @@ Have a look at the [CONTRIBUTING file](https://github.com/jamulussoftware/jamulu If you aren't comfortable with Pull Requests, commits, etc. just open an issue. We will then take care of your changes. If you want to do the changes on your own and open a Pull Request, follow these instructions: 1. Fork the repo (there's a fork button on the top right of the GitHub page) -2. Decide which branch you have to commit your changes too (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch; more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up to date branch you chose +2. Decide which branch you have to commit your changes to (rule of thumb: everything which might need translation should go to the `changes` branch, typos should go to the `release` branch; more information can be found in the [CONTRIBUTING file](https://github.com/jamulussoftware/jamuluswebsite/blob/changes/CONTRIBUTING.md)). Create a new branch from the up-to-date branch you chose 3. Make your changes 4. If you did the changes offline, push the new branch to your repository 5. Submit your Pull Request, give a short description of your changes and link the issue you opened From 51b4a58588d6d26807f9dfdd3cedcf88a613e28d Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Fri, 18 Dec 2020 22:12:04 +0100 Subject: [PATCH 15/19] gilgongo fix --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e51b5de24..7428aa184 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,13 +17,13 @@ Pull requests/issues for the website should have a title which looks like this: ## Branches, Translation and development process -We currently use multiple branches to ensure that translators know what to translate. Therefore have a look at the guideline below. +We currently use *multiple branches* to ensure that translators know what to translate. After having discussed and agreed on changes you want to be integrated to jamulus.io, you should ask yourself some questions: ## 0. Is the language of your content already online and existing? -No: Will discuss this later (since you introduce a new language). -Yes: +If not: This will be discussed this later (since you introduce a new language). +If so look here: ### 1. Be clear if your change needs translation **No:** A fix which doesn't need to be translated (e.g. typo) --> Open a Pull Request to `release`. It will go live a few minutes after the PR is merged **Yes:** A fix which needs to be translated (e.g. if you want to make a sentence or paragraph clearer) --> Commit to `changes` since others will need to translate it. It will be part of the next release. From 16720da63fd605d063175ce275cce66df5beca95 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Fri, 18 Dec 2020 22:13:12 +0100 Subject: [PATCH 16/19] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7428aa184..3ddafd97a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ We currently use *multiple branches* to ensure that translators know what to tra After having discussed and agreed on changes you want to be integrated to jamulus.io, you should ask yourself some questions: -## 0. Is the language of your content already online and existing? +## 0. Is your content in a language that already exists on the site? If not: This will be discussed this later (since you introduce a new language). If so look here: ### 1. Be clear if your change needs translation From eb34e7dd34020e319ad09df7c21582fd75fb6e89 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Fri, 18 Dec 2020 22:16:02 +0100 Subject: [PATCH 17/19] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da0dce00d..d8724100c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is the home of the [Jamulus website](https://jamulus.io). The goal of this page is to explain what Jamulus is and how to use it. -## Contribute and translation +## Contribute a translation Do you want to contribute to the Jamulus Wiki/Website? Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. @@ -38,7 +38,9 @@ Have a look at the README.md files in these folders. This site is built with Jekyll and Fox-CSS. ## Contribute to the design/site structure +Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. +### A few tips/links Since this page uses Jekyll, please have a look at the [Jekyll documentation](https://jekyllrb.com/docs/). This project uses the FOX-CSS framework. See the [FOX-CSS documentation](http://www.fox-css.com/documents/). CSS files can be found in the assets/css folder. From 6cda430b0a382a248efe28faa60e17b603a888ca Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Fri, 18 Dec 2020 22:16:57 +0100 Subject: [PATCH 18/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8724100c..6da9021e7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is the home of the [Jamulus website](https://jamulus.io). The goal of this ## Contribute a translation -Do you want to contribute to the Jamulus Wiki/Website? Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. +Do you want help out with translation? Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. ## Adding pictures Unfortunately GitHub doesn't enable picture upload on the normal md editor. Therefore you can attempt to open an issue, upload your image, copy the link to the page you want to integrate it into and then don't submit the issue. See this answer on stack overflow: https://stackoverflow.com/a/26601810 From 4374bb562ff3ee0d2cadb54cd56e5e46fac74f0e Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Sat, 19 Dec 2020 21:22:41 +0100 Subject: [PATCH 19/19] Update README.md --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6da9021e7..006542db1 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,12 @@ This is the home of the [Jamulus website](https://jamulus.io). The goal of this page is to explain what Jamulus is and how to use it. -## Contribute a translation - -Do you want help out with translation? Please open an issue and see the [CONTRIBUTING.md](CONTRIBUTING.md) file. - ## Adding pictures Unfortunately GitHub doesn't enable picture upload on the normal md editor. Therefore you can attempt to open an issue, upload your image, copy the link to the page you want to integrate it into and then don't submit the issue. See this answer on stack overflow: https://stackoverflow.com/a/26601810 -## Translating +## Contribute a translation -**Before translating, please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file to get familiar with our translation process** +**Before translating, please have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file to get familiar with our translation process. Afterwards, check if there's already a discussion thread for your language here: https://github.com/jamulussoftware/jamuluswebsite/discussions and participate in it** Translations are handled by the [Polyglot Jekyll Plug-in](https://github.com/untra/polyglot). If you want to translate a file, you must first know where it is located on this repo: