Textpattern CMS support forum

You are not logged in. Register | Login | Help

#1 2017-11-01 09:08:07

philwareham
Core designer
From: Farnham, Surrey, UK
Registered: 2009-06-11
Posts: 3,093
Website

How to contribute to Textpattern documentation

The Textpattern CMS user documentation is a collaborative project to keep Textpattern’s documentation up to date. That site is served from static files on GitHub via Jekyll.

Helping to edit current documentation and/or writing new documentation by Textpattern users is strongly encouraged!

If you are familiar with Git/GitHub workflows then you can fork this repository, make your edits/additions and then open pull request. A member of the core documentation team will then review you changes and merge into the repository once approved. The site is built using Jekyll every time a file change is detected, and the page is then live for everyone to see.

For simple, smaller edits, you can edit documents in-browser on GitHub as follows:

1. Log into GitHub in your browser.
2. Go to the docs repo.
3. Find the documentation page you want to add an example too, pages are within sub-directories of root and all labelled logically.
4. Click the ‘Edit this file’ button (it’s a little pen symbol).
5. Write/edit content (in Markdown syntax).
6. Press the ‘Commit changes’ button when finished – that will create a pull request. A member of the core documentation team will then review you changes and merge into the repository once approved.
7. Jekyll rebuilds automatically when file changes are detected and the page is then live for everyone to see.

Further information on formatting and writing style are within the repo’s README file.

Offline

Board footer

Powered by FluxBB