Skip to content

Latest commit

 

History

History
68 lines (37 loc) · 6.04 KB

README.md

File metadata and controls

68 lines (37 loc) · 6.04 KB
Raw

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.

Translation

Translation status

The Jamulus application and website are translated using Weblate, where you can check the status of each separate file. If you would like to help with translations, before you start, please read the instructions for translating the website or the Jamulus application.

Introduce yourself on the GitHub Discussions and tell us what you’d like to do.

If you prefer to submit translations via pull requests rather than using Weblate, feel free to do so. However, make sure you coordinate with other possible translators to your language in order to avoid duplicating work and the risk of conflicts on GitHub.

PLEASE NOTE: Discussions should be in English so as to be open to all.

Making changes to the documentation

Important: Any changes to the content of the documentation must be made to the English version first, as it is the source for all translations.

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.

Viewing the website offline

To view the website offline on your own machine, you will need to use Jekyll to build it. You can find instructions on installing Jekyll and building the website here. The easiest way is to make a pull request with your changes, click on the "Checks" tab of your pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run bundle exec jekyll serve. Type http://127.0.0.1:4000/ into your browser's address bar and you should see the website. Please ask in 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 %}" …

These files are located in _assets/img/LANG-screenshots.

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.

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 them on Weblate, or edit the .po files for their language in _translator-files/po/LANGUAGE/ and open pull requests to merge them into the "next-release” branch.
  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

  • 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 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, 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.