-
Notifications
You must be signed in to change notification settings - Fork 115
Home
If you want to update an already existing page, you do not need to follow the standard Github procedure. Instead, simply browse the code online to find the file you want to edit and click on Edit this file (pencil in the upper right corner of the file viewer). Find out more here: https://help.github.com/articles/editing-files-in-your-repository. Dead simple, no more pull, branch, edit, add, commit, pull request. Note that your changes are still reviewed by a moderator, though.
However, this applies only if the file (e.g. the project or the people's database) already exists. Otherwise, proceed with the guides provided here/below.
The JLESC website is a set of static HTML5 pages generated with a tool written in Ruby called Jekyll.
To add or modify the content of specific parts of the website, only a few plain text files written with the Markdown markup language have to be edited.
There is one general rule for getting into editing:
Don't get afraid of the overwhelming number of additional documentation pages to the right. It all comes down to this: create a pull request and wait for a maintainer to approve. If you do not know how to do that, here are the three basic steps to follow:
-
Fork and clone the repository
first read Basic Setup and continue with Contributor's Workflow for details -
Add new or correct and extend existing content
after reading Structure and Orientation, see Basic Editing Knowledge, Editing Data and Editing Pages for details -
Push your changes to your fork and open a pull request.
see Step 3 ff. in Contributor's Workflow
There is also a comprehensive guide from GitHub on sending pull requests.
Read the Rationale for details on the choice for Ruby/Jekyll and this procedure.
Please, by all means, notify us when anything is unclear in this wiki or the in-source documentation!