Contributing documentation
This page is for anyone who wants to make the documentation better. You need a GitHub account; no programming.
Fix a page in two minutes
Every help page has an "Edit on GitHub" link. Open it, change the text in the browser, and propose the change as a pull request. Typos, outdated steps, unclear sentences: all welcome.
Write a new help page
The help shows the git-tracked files in doc/. A help page is a Markdown file under doc/eng-us/help/ that starts with
front matter:
---
title: <Title>
audience: editor, admin
category: editing
order: 50
summary: <One or two sentences: who it is for and what it answers.>
keywords: <comma separated>
type: help
---
# <Title>
<First paragraph: who the page is for and what it answers.>The audience and category values the help understands are configured in settings/exphelp.ini.
Style that makes pages trustworthy
- American English; "Exponential" for the product; the old name eZ Publish only for history.
- Every fact with its source: a file, a page, or a command with its expected output.
- Steps that work on a current installation; say which version you tested.
- No secrets, no private host names, no personal data in examples.
- Tables and checklists where they help; short sentences.
License
The documentation is free documentation under the GNU Free Documentation License 1.3 or later (The license of this documentation). Your contribution is published under the same license, so others may copy, translate and improve it (Free documentation).
Other places to write
| Place | What | License |
|---|---|---|
| eZpedia https://ezpedia.exponential.earth/ | "The free eZ Publish encyclopedia that anyone can edit", since 2006 | GFDL |
| share.exponential.earth https://share.exponential.earth/ | Forums, blogs, tutorials | As stated on the site |
| Your own blog | Tutorials and stories | Your choice; a free license helps others reuse it |
What the documentation needs most
- How-tos for tasks people ask about in the forums.
- Screens of the current administration in tutorials that still show old ones.
- Translations of help pages (Contributing translations).
Related pages
- Contributing translations
- Free documentation
- Develop with Git
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.