Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

Textpattern user documentation repository

This repository drives the Textpattern user documentation website. Contributions are welcome and encouraged!

How to proceed

As follows:

  1. Review the documentation collaboration procedures. The who, what, when, where, (you know why), and how of it all.
  2. Review the user documentation guidelines. These provide near everything you need to know for writing and editing documentation, specifically.
  3. Review the editorial style guide. This is Textpattern's baseline editorial guidelines across all project sites and written material. Here will be high-level rules about orthographical style, spelling, punctuation, brand name usage, and so on. (If you get a 404, the document is still under major revision. Skip to next item and please come back later.)
  4. Continue according to skill level or interest…
    • If drafting new pages (and/or editing existing pages): Clone this repository (we assume you know how). If aiming to draft something new, ensure you have already proposed the page and got consensus. And use the documentation page template to start easier.
    • If editing existing pages only: Clone repository or use GitHub's web interface, explained in next section.

Whether you clone the repository or use the web interface to make changes, a pull request will be initiated and reviewed by repository owners.

Important! Before making any changes to documentation pages, look at the open issues list to see if anyone else is already assigned on the page and the issue appears with a 'drafting' or 'editing' label on it, or any other label that suggest someone is actively focused on the document. If so, do not touch those pages until such labels are removed. At that point, if you're still inclined, contact the assignee(s), if any remain indicated on the issue, and enquire about the document's status. Version control is a wonderful thing, but there is a collaborative editorial workflow in place too. We don't want to make roll-backs unnecessarily.

Editing via GitHub's web interface

If you want to help edit existing pages, and have a GitHub account but would rather not fork or clone around, you can work directly via GitHub's web interface.

Proceed as follows:

  1. See steps 1 through 3 in the list above.
  2. Inform collaborators of what you think needs done via an issue, in this way:
    1. Search all issues (both open and closed) to see if an issue already exists for the page you're concerned about (subject pattern is page: {title of page}). If it does exist, use that issue to discuss the objective, re-opening it if necessary.
    2. If no issue already exists for the page, open a new issue using the Propose new page template. This will be the dedicated issue for the page going forward.
  3. When clear how to best make revisions, via issue discussion, go to the page in the documentation tree, likely organized in one of the following subdirectories: administration, development, faqs, tags, or themes. (The brand directory is for editors only.)
  4. Click the pencil icon at top-right of the document (the hover text will read, 'Edit this file'). You'll then be in document edit mode.
  5. Make your revisions. Ensure you're following conventions for strings formatting and marking up pre-defined content elements.
  6. Hit the Commit changes button when finished. This will initiate a pull request. The request will be reviewed (and likely merged) by a repository owner.
  7. Check your changes in the front-end of the document to ensure any formatting or styles used were applied correctly.