Contributing documentation and help pages
The help you are reading is free documentation, written in Markdown in the repository under doc/eng-us/. Anyone
can improve it, and no programming is needed.
Contents
Fix a page
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 (Contributing documentation). Typos, outdated steps and unclear sentences are all welcome.
Write a new page
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>The audience and category values the help understands are configured in settings/exphelp.ini
(Contributing documentation). Help pages end with a "Related pages"
list. The help shows the files that git tracks, so a new page appears once it is committed.
Style rules
From Contributing documentation:
- American English; "Exponential" for the product; the old name 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.
Checking your page
On a clone, ./console exp:help check checks "the links and images of the pages" (bin/php/exphelp.php); fix every
error it lists before you open the pull request. ./console exp:help show <page id> shows the metadata and headings
of one page. The help system is described in The help system.
The license
The documentation is under the GNU Free Documentation License 1.3 or later; your contribution is published under the same license, so others may copy, translate and improve it (Free documentation).
Other places to write
| Place | What | Page |
|---|---|---|
| eZpedia | A community encyclopedia under the GFDL, for tricks and how-tos | Contributing to eZpedia |
| Share | Blogs, articles, tutorials | Publishing on Share and Projects |
Related pages
- Contributing as a community member
- Improving the help
- Keeping the help up to date
- Keeping help accurate
- 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.