Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Contributing documentation and translations

How partners contribute to the documentation and the translations of Exponential - editing help pages on GitHub, writing new pages with front matter, the GFDL, translating the administration, and why documentation work…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/partners/contributing-docs-and-translations.md

On this page

Contributing documentation and translations

This page is for partner staff who write or translate. Documentation and translations are among the most valuable contributions: partners see the questions customers ask, and serve customers in many languages.

Documentation

  • The documentation lives in the repository in doc/, and the help shows it in the administration (Free documentation).
  • Every help page has an "Edit on GitHub" link: fix a mistake directly with a pull request.
  • New help pages are Markdown files with front matter (title, audience, category, order, summary) under doc/eng-us/help/.
  • The documentation is licensed under the GNU Free Documentation License 1.3 or later; your contribution will be too (The license of this documentation).

What partners can document well

TopicWhy partners
Real-world setups (hosting panels, containers, clouds)You run them
Migration storiesYou did them
Editor how-tosYou trained editors
Answers you give repeatedlyThey belong in the help

Writing rules

  • American English; product names right (Naming and brand rules for partners).
  • Every fact with its source; commands with expected output.
  • No secrets, host names of private systems or customer data in examples.

Translations

  • The administration is translated into many languages; Languages explains the locales and doc/eng-us/languages.md lists the catalogues and their completeness.
  • Translations live in share/translations/<locale>/translation.ts. Improve an existing language or complete a partial one with a pull request.
  • Have a second native speaker review before you submit.

Points

Tutorials (1,500+ words) and articles (500 to 1,500 words, FLOSS-licensed) earn 500 points each; "wiki article documentation or documentation" is named as knowledge sharing (https://exponential.earth/partner/requirements). Translations are not listed; ask the partner team, as "case-by-case" activities can be rewarded.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x