index.rst

Contributing to these docs

Submitting suggestions

Have a suggestion for improvement? Share it with us by opening an issue.

Authoring content

Setup authoring environment

1. Install Sphinx and the ReadTheDocs theme locally:

   $ pip3 install sphinx==7.2.6 sphinx_rtd_theme==2.0.0 sphinx-design==0.5.0
   

   This can be in your home area, a virtual environment, container, etc.

   Note

   This has been most recently tested with Python 3.10

2. Fork the documentation repository on GitHub

   Go to https://github.com/olcf/olcf-user-docs, and click the "Fork" button in the upper right corner.

   

3. Clone your fork of the documentation repository:

   $ git clone https://github.com/<your-github-id>/olcf-user-docs.git
   

4. Point your master branch to track upstream:

   $ cd olcf-user-docs
   $ git remote add olcf https://github.com/olcf/olcf-user-docs.git
   $ git fetch olcf
   $ git branch --set-upstream-to=olcf/master
   

5. Build the docs:

   $ sphinx-build -E . _build
   

   Or:

   $ make html
   

6. Locally preview the generated web pages

   Start a webserver on localhost:8080 that points at your olcf-user-docs/_build directory. For example, using busybox:

   $ busybox httpd -p 127.0.0.1:8080 -h /home/ubuntu/olcf-user-docs/_build
   

   or a python webserver (from inside the document root, i.e., _build directory):

   $ cd _build
   $ python3 -m http.server 8080
   ## you may add the option --bind 127.0.0.1 to bind only on the localhost address
   

   Open a browser and type localhost:8080 into the address bar to view the web pages.

   On macOS:

   $ open _build/html/index.html
   

Edit the docs

After having set up your environment as described above, you can reuse your local environment to make multiple changes.

1. Update your local clone from the upstream repository:

   $ git checkout master
   $ git pull
   

2. Make your edits in a new git branch:

   $ git checkout -b my-edits-branch
   ## make edits to *.rst files, using an editor like vi
   ## after my-edits-branch is created, omit the -b flag to switch to it from the master
   

3. Preview your edits

   Follow the steps in the previous section to rebuild and locally view changes

4. Add and commit your edits to your branch:

   $ git add edited_file1.rst edited_file2.rst
   $ git commit -m "message summarizing your edits"
   

5. Push your edits to your GitHub fork:

   $ git push -u origin my-edits-branch
   

6. Open a pull request on github

   After you push your branch, you should see a button to open a pull request.

   

Resources

Sphinx Quickstart

restructuredText Primer

restructuredText Reference

GitHub Guidelines

Here are some guidelines and common practices that we use in this project.

• When you want to work on an issue, assign it to yourself if no one is assigned yet. If there is somebody assigned, check in with that person about collaborating.
• Reference the issue(s) that your PR addresses with GitHub's '#' notation.
• Use "WIP" in your PR title to indicate that it should not be merged yet. Remove just the WIP when you are ready for it to be merged.
• If you think certain individuals should be aware of your proposed changes, suggest them as reviewers on the PR.
• You do not need to assign labels to your PR, but you may do so if you have suggestions. However, be aware that the labels might get changed.