Documentation Team Initial Setup

This topic lists tasks for new Doc team members.

Git Bash Set Up

This is a one-time set up, unless you change laptops.

  1. Install Git Bash by downloading from here: https://git-scm.com/
  2. Follow these steps to set up Git Bash for the first time: https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup

SSH Authentication Set Up

This is a one-time set up, unless you change laptops. You must have a GitHub account for this to work.

We connect to the GitHub repos using SSH Authentication. Follow these steps to set it up.

On this page:

Generating a new SSH key and adding it to the ssh-agent - GitHub Docs

Perform the steps in these sections:

  1. Generating a new SSH key - GitHub Docs

  2. Adding the key to the ssh-agent - GitHub Docs

Perform all the steps in these topics:

  1. Adding a new SSH key to your GitHub account - GitHub Docs

  2. Testing your SSH connection - GitHub Docs

Perform the steps in this googledoc:

  1. Set up an auto-launch of the SSH agent

If you're using an ED25519 SSH key, which is the latest standard for GitHub access, you may need to create a config file that tells your SSH agent which SSH key to use.

  1. Set up config file for SSH agent

Initial Clone of Project Files

:NOTE You only perform these steps one time when you set up your repo for each project. After you have it cloned locally, you will use pulling and pushing to move your changes to remote branches.

Prior to doing any work on the Stewardship Tier help, you must obtain a copy of the BackOfficeAssoc dsp-docs repository for your local computer. This repo is the source control for the SST online help Flare project.

The SKT help and the Installation Manuals are also stored in github as Flare projects and the process to clone these three projects is the same (though the underlying folder structure is not).

To clone the dsp-docs repo (SST online help) to your laptop:

  1. In GitHub, go to the dsp-docs repo here.

NOTE: The SKT repo is here (you can follow these steps using “igc-help” in place of “dsp-docs”). The Install Manual repo is here (you can follow these steps using “dsp-install-manuals” in place of “dsp-docs”):

  1. Click the Code button.

  2. Under Clone, select the SSH tab.

  3. Click the Copied icon to the right of the url text box to copy the URL to the clipboard.

    NOTE: Ensure you are cloning using SSH, and not HTTPS (the default active tab).

  1. In Windows Explorer, right-click the default git location to clone repos and select Git Bash Here.

    NOTE: These steps use the default location of Users > Jenny Drummey > git.

    NOTE: The repository will be cloned into a new directory below this default git folder location you specify, with the same name as the repository. For example, following these steps, your dsp-docs repo is cloned to. C:\Users\Jenny Drummey\git\dsp-docs.

    NOTE: If you have set up SSH Authentication, you may need to enter your passphrase when the bash window opens. Refer to Set Up SSH Authentication for more information.

  1. Enter git clone then right-click and select Paste.

NOTE: The result should look like this:

git clone git@github.com:BackOfficeAssoc/dsp-docs.git

  1. Press Enter to clone the repo locally.

  2. Enter the command cd dsp-docs to switch into the newly cloned repo’s directory.

NOTE: The command prompt displays the repo and branch name , ex. Documents/GitHub/dsp-docs (develop) shows repo name of dsp-docs and branch name of develop.

Refer to Author Checks Out Branch to Add Content for more information about working in git.