Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.07 KB

README.rst

File metadata and controls

37 lines (26 loc) · 2.07 KB
Raw

CliMAS Computing Documentation

Documentation Status

This GitHub repository contains documentation for computing within the Department of Climate, Meteorology & Atmospheric Sciences at the University of Illinois Urbana-Champaign.

The latest version of documentation may be viewed at https://computing-docs.readthedocs.io/en/latest/

Steps for producing documentation locally

For contribution/testing purposes, the documentation may be compiled locally by changing into the docs directory by:

cd docs

And the HTML code can then be produced by:

make html

with the result being viewable by accessing build/html/index.html.

Recommended workflow for contributing to this documentation project

  1. Fork this repository by clicking the Fork button on the atmsillinois/uiuc-atmos-computing GitHub page or clicking here
  2. Clone the forked repository locally: git clone https://github.com/<GitHub username>/<whatever you named your fork repo>.git
  3. Checkout a new branch locally that you intend to work on (as an example, called new_documentation): git checkout -b new_documentation
  4. Consider submitting an Issue listing your anticipated contribution or comment on an existing Issue.
  5. Make desired changes to this local branch to address your target issue.
  6. Push this new branch to your Fork: git push origin new_documentation
  7. Create a Pull Request with atmsillinois/uiuc-atmos-computing main by selecting "compare across forks" and suggesting that your new branch be incorporated. This may be initially done as a "Draft" if your work is not yet finalized.