Site Contributions

These are the instructions for how to contribute to the SCINet Workbooks webpage if you have been contacted to contribute.

There are a few ways to do this.

1. Using Github pull requests (preferred).
2. Edit online in github.
3. Send your markdown file to Moe Richert

If you are unsure where the information you are trying to edit is located, navigate to the page on the SCINet website and scroll to the bottom of the page. There is an "Edit this page" link in the footer that will take you to the corresponding file in the github repository. If you are still unable to find the information you are trying to update, email Moe Richert.

The github command line

1. Get a GitHub account if you don't have one
2. Clone the repository to your computer
3. Create a new branch for your work
4. Edit your assigned page, photos go in /assets/img/ in their respective subfolder, and docs go in the location you were assigned
5. When you are done commit your changes:

git add .
git commit -m "here is a description of what I did what I did"
git push

6. Then go the main scinet repository and create a pull request

Edit online in Github

1. Get a GitHub account if you don't have one
2. Go to the SCINet repository, navigate to your file, and click the pencil. This will fork the archive for you.
3. Edit the file, say what you did in the comment box, and click "Propose changes" or "Create a new branch for this commit and start a pull request."

Using this repository locally

To get started

This site uses Jekyll - a ruby gem. You will need Ruby to use this repository locally. If you do not already have Ruby installed, you can use the Jekyll guide to get set up: https://jekyllrb.com/docs/

Clone the repository, then run 'bundle install' to get dependencies.

To run the app, you can run 'bundle exec jekyll serve'

Edits made to _sass/styles.css will not be retained when USWDS is updated. It is overwritten when the USWDS scss is compiled.

Where to find files

If you are unsure where the information you are trying to edit is located, navigate to the page on the SCINet website and scroll to the bottom of the page. There is an "Edit this page" link in the footer that will take you to the corresponding file in the github repository.

Workbooks

Workbooks are now stored in workbooks/_workbooks.

If an additional category is needed, a new folder should be made in the _workbooks folder. Defaults for that folder can be set in _config.yml.

Please contact Moe Richert with any questions or development needs.