Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 1.84 KB
Raw

Contributing

  1. Create a new Issue
  2. Discuss Issue with Community Working Group (WG) --> Create Pull Request (PR) if required
  3. PR to be submitted against the main branch
  4. PR discussed with the WG. If agreed, the WG Chair will merge into main branch

Contributing a Translation

We welcome community contributed translations of the course.

Prepare your translation

To make the process simpler we have created a locale template that you can duplicate and update.

To prepare your translation follow these steps:

  1. Fork the repository: https://github.com/Green-Software-Foundation/learn/fork
  2. Create a new branch for your translation - e.g. "translation-de".
  3. Duplicate the template locale folder - "/i18n/template".
  4. Name the new folder based on the language locale code - e.g. 'de' for German
  5. Update the course content in the "docusaurus-plugin-content-docs/current" folder.
  6. Optionally update the images in "docusaurus-plugin-content-docs/current/images". Contact us if you need access to the original image assets.
  7. Update the UI elements in "docusaurus-theme-classic/footer.json" & "docusaurus-theme-classic/navbar.json".

Test your translation

npm -g install yarn
yarn install
yarn run docusaurus start --locale <locale>

Submit for review

  1. Raise a Pull Request for your translation against the main branch.
  2. The PR will be reviewed by the the project team and feedback will be provided within 4 weeks.

Go Live

Once approved the translation will be published on https://learn.greensoftware.foundation/