This is the content repository for jamulus.io. Text appearing in the Jamulus software application itself is part of the main code repository. The web site is built with Jekyll and Fox-CSS.
(Note that any significant changes must be made to the English first. See the translation process later in this document if you want to get involved with that.)
To edit an individual file, you can use the Github web interface or make a fork of the Jamulus repository (button at top right here). In your fork, you can edit multiple website pages (or of course use git on the command line if you prefer). When you are done, create a pull request that we will review, translate and publish in the next release.
To view the website offline one your own machine, you will need to clone it locally and use Jekyll to build it. Please ask on in the discussions for help with this if necessary.
We use GitHub markdown to format the basic text. Have a look at the markdown in existing pages for examples.
Note that we use British English spelling and grammar conventions.
Use the {{site.url}} variable to call an existing image in the corresponding directory for that language. This ensures the correct URL is used:
<img src="{{site.url}}/assets/img/en-screenshots/mixer-channles.png" …
If you want to add a new image, use .png format if possible, and if it’s not a screenshot, ask about where you should store it. Localised images must go in a directory for that language (see the example for English, above).
- Home page
- Getting Started
- Installation pages
For translating text in the Jamulus application itself, please see TRANSLATING.md
We collect changes to the English version of the site on a "changes" branch first. We then freeze changes prior to a Jamulus software release, and do a translation "sprint" over a couple of weeks when all translation takes place.
- Changes are first made to en-*.md files and committed to the “changes” branch.
- Once we’ve agreed the changes can go live (usually just before a software release), we then create GitHub issues for each language, tagged for that release. You can ask questions about the work there.
- We then create a “translation_[versionNo]” branch which contains all relevant changes in a single commit for easy translation (
git branch translation_[versionNo] release && git checkout translation_[versionNo] && git merge --squash changes). - Translators for each language then update any affected files in their language and open pull requests to merge them into the "translation_[versionNo]” branch. Those pull requests are linked to the relevant GitHub issue in step 2 so they can be tracked.
- When all translations are merged (issues will then close automatically), we merge that new branch into the
releasebranch, which is automatically made live on the production site.
-
Each page on the site has a .md or .html language suffixed version. Most of the website content is in _includes/wiki/[langCode]. 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
-
Please do not add new or significantly modified content to a non-English .md or .html file. All changes must be made on the changes branch in English first after being discussed here.
-
Please make sure you are aware of what stage of the workflow we are currently at by monitoring the project board, 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.
-
Pull requests for translations should have a title which looks like this:
[Tag (Translation)][language code (e.g. en)] {short description of your changes}
Make sure to add the language to the _config.yml file (in the languages array). At a minimum, 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 also be translated.