michaelkpate / pophelp

Textpattern CMS help files.

Textpattern CMS help files

This repository contains Help files (aka ‘Pophelp’) for Textpattern CMS. These Pophelps are the translation file format Textpattern will eventually use in a future version.

Specification

Structure:

help/
    {language}/
        {article}.textile

Contents:

h1. Article title

Body.

Contributing

To make corrections to existing translations, or to add new ones, fork the repository. Once you are done, send in a pull request.

Contributing via GitHub web editor

GitHub’s web based editing features allow you to easily do smaller edits to existing translations without you needing to delve into git. Changing files through the web interface isn’t really recommended, but its an option for those that do not use git, or are away from their computer.

To contribute to a translation directly from GitHub.com website:

1. Navigate to a Pophelp file you would want to alter, e.g. help/en-gb/body.textile.
2. Hit the Edit button above the presented file contents.
3. Do some alterations to existing text (using Textile syntax).
4. After you’ve done, fill in the short commit message describing the change, e.g. “Fixed typo”.
5. Hit the Save button.

Now to submit in a new pull request with your changes:

1. Hit the Click to create a pull request for this comparison link on the page presented to you after saving, or you can use the Compare and pull request button on your fork’s repository page.
2. Fill in the comment field; explain what your changes do. Be precise and clear.
3. Hit the Send pull request button.

Once your pull request is processed and marked closed (merged or denied), go back to your GitHub profile page and delete your clone of the Pophelp repository:

1. Find the pophelp repository on your profile page; it should be listed on your repository list.
2. Open it.
3. On the repository’s page, hit the Settings link.
4. Scroll down until you see Delete repository button.
5. Hit it and confirm the action.