Home

Robert Speck edited this page Mar 8, 2016 · 23 revisions

What?

The JLESC website is a set of static HTML5 pages generated with a tool written in Ruby called Jekyll.

How?

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:

Read the source, Luke!

Really?

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:

  1. Fork and clone the repository
    first read Basic Setup and continue with Contributor's Workflow for details

  2. Add new or correct and extend existing content
    after reading Structure and Orientation, see Basic Editing Knowledge, Editing Data and Editing Pages for details

  3. 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.

Ok?

Read the Rationale for details on the choice for Ruby/Jekyll and this procedure.