metafresh logo and link to homepage

How to get started with translating docs?

1. Understand the task

  1. get access to latest version of metasfresh
  2. play through the manual in german first http://docs.metasfresh.org/webui_collection/DE/NeuerProduktionsauftrag.html
  3. report feedback on github if documentation is not fitting
  4. switch the language to EN
  5. play through the workflow again
  6. report feedback on github if not all fields are translated
  7. check other examples that already have been translated:
    1. http://docs.metasfresh.org/webui_collection/DE/Auftrag_erfassen.html
    2. http://docs.metasfresh.org/webui_collection/EN/SalesOrder_recording.html

2. Install your tools

  1. Install github desktop
  2. Install and configure Atom Editor

3. Prepare Repository

  1. Github Desktop: clone metasfresh/metasfresh-documentation to your local disk
  2. switch to the gh-pages branch
  3. create a branch with the name gh70 (gh+ issue number)

4. Develop translation

  1. open atom and duplicate existing .md file
  2. create an english translation manual in markdown language

5. Commit your changes

  1. commit the new file using:
  2. create a pull request for review

Further Reading


Zur Quelldatei auf github.com