Website SoftwareCarpentry - usnistgov/carpentries-development GitHub Wiki

Set up the workshop repository based on https://github.com/swcarpentry/workshop-template.

The following deviations from the template instructions must be made:

• When importing the workshop-template repository, set the owner to the usnistgov organization on github. Choose a name for the repository of the form YYYY-MM-DD-nist, e.g., 2015-07-23-nist.

  • Add the SoftwareCarpentryInstructors team (under the usnistgov organization) to the repository via Settings > Manage access
    • If necessary, request to join SoftwareCarpentryInstructors via the team page
  • Contact [email protected] with any questions or concerns.

• Per NIST policy, you must do your work in your repository's nist-pages branch (not in gh-pages) .

  • In the GitHub interface, select the Settings tab, then Branches, and click the pencil to edit the name of the default branch from gh-pages to nist-pages. A warning should appear. Accept this. Note: This is different from selecting the nist-pages branch in the Code view.

• Edit the _config.yml file to replace the magic fields in repository: <USERNAME>/<PROJECT> with literals, e.g., repository: usnistgov/YYYY-MM-DD-nist

• Push the content to the https://pages.nist.gov server by following the instructions at https://github.com/usnistgov/pages-root/wiki/Configuring-your-repo-for-publishing-on-pages.nist.gov .

  Note: NIST templates are forthcoming and may conflict with the SoftwareCarpentry templates.

  Your workshop webpage should appear at https://pages.nist.gov/YYYY-MM-DD-nist

• Between the information on setting up a GitHub account and the tabs for different platforms, edit _includes/install_instructions/git.html, to include information about the NIST RoB:

  <div class="alert alert-warning">
    If, <em>after</em> this workshop, you will be using GitHub in the course of your NIST work,
    you must comply with the <a href="https://inet.nist.gov/odi/github">NIST GitHub Rules of Behavior</a>,
    including having a "publicly viewable nist.gov email address as part of [your] GitHub profile".
  </div>