Jamulus Website

This is the content repository for jamulus.io. Text appearing in the Jamulus software application itself is part of the main code repository. See also the general overview to getting involved.

Making changes to the English version

Note 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.

Formatting and style

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.

Adding screenshots

In order to keep the size of the respository under control when images change over time, we do not store screenshots locally. Instead we use Jekyll's include function to call a file containing an external URL to the image itself:

<img src="{% include img/en-screenshots/main-screen-default.inc %}" …

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).

To get the URL for the .inc file, open a Github issue (in any repository) and add your image to it. Github will generate a URL for it like this:

![your-image-name](https://user-images.githubusercontent.com/45617 … .png)

Put that URL (only the part within the brackets) into the .inc file, saving that in the appropriate directory to be used as above for <img src=. Note that because Github generates unique "anonymous" URLs for every image, the include method allows us easily to manage the same image used in multiple places if necessary.

Style and tone

Please have a look at our style and tone guide.

Translating

To make updates or translations for jamulus.io you will need a GitHub account and be familiar with GitHub in general. If you want to get more involved, you’ll need to be familiar with the use of git on the command line, as well as Jekyll. Note that translating the Jamulus application itself is done by a different process, but you are welcome to help with that too. Introduce yourself on the GitHub Discussion and say what you’d like to do.

Please also note that discussions should be in English so as to be open to all.

For details on the website translation process, please consult the README file here

For translating text in the Jamulus application itself, please see TRANSLATING.md in the application repository.

Overall workflow

We collect changes to the English version of the site on a "next-release" 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.

1. Changes are first made to EN (= English) *.md files and committed to the “next-release” branch.
2. 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.
3. Translators for each language then update any affected files by editing the .po files for their language in _translator-files/po/LANGUAGE/ and open pull requests to merge them into the "next-release” branch. Those pull requests are linked to the relevant GitHub issue in step 2 so they can be tracked.
4. When all translations are merged (issues will then close automatically), we merge that new branch into the release branch, which is automatically made live on the production site.

Points to note

• Please do not add new or significantly modified content to a non-English .html file and do not edit any non-English .md files, as these changes would later be lost. All content changes must be made on the "next-release" 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.