Basic Setup

To contribute to the JLESC website, only a few very basic things are required on your computer:

• Linux or OSX operating system.

  ❗ Windows is not tested and will most likely mess things up. ❗

• Git

• your favourite plain text editor ¹
  potentially with Markdown and YAML support (i.e. syntax higlighting)

For people contributing on a regular basis or handing in larger changes, we strongly recommend setting up a local environment to test the site locally.

Preparations

These steps are usually only required to be done once (unless you really mess something up 😉).

In the Web Browser

1. Get a GitHub account. (if you don't have one yet)
   It is free and no hidden costs are burried.

2. Log into your GitHub account.
   All following steps are assuming you are logged in.

3. Fork the JLESC website repository to your account.

   This creates a non-synchronised copy of the website repository in your account.

On your Computer

1. Configure SSH
   We strongly encourage people to use SSH and NOT HTTPS!

2. Find yourself a nice place on your computer for the JLESC website repository to live in, e.g. $HOME/projects:

    cd $HOME/projects
   

3. Clone the JLESC website repository:

    git clone [email protected]:JLESC/jlesc.github.io
    cd jlesc.github.io
    git remote rename origin upstream
   

4. Setup Git user name and email
   For the sake of clarity and to avoid confusion with your colleagues, please use your real (full) name (as you do on papers) and your email address of your official JLESC affiliation (i.e. ANL, JSC, etc.) for user.name and user.email:

    git config --local user.name "John Doe"
    git config --local user.email "[email protected]"
   

5. Configure your personal fork:

    git remote add my_fork [email protected]:<YOUR_GITHUB_USERNAME>/jlesc.github.io
   

   Hopefully, it is obvious that you replace <YOUR_GITHUB_USERNAME> above with your actual GitHub username, e.g. torbjoernk

   You will use the upstream repository (Git know it as upstream) to receive updates and your own fork (Git will know it as my_fork) to push your changes and additions to.

As stated above, these steps should only be required once. To contribute, read on the Contributor's Workflow.

---

1: In general it is also possible to add and modify the content without leaving GitHub and the comfort of the web browser. However, we will not discuss this option here as we advice against it.