Git Repository Creation / Cloning

If creating a new document, you need to create a GitHub repository to store a copy of your documentation project online and manage changes to it, and then clone this repository to your local computer for editing.

If you are editing an existing document that you have not yet configured locally, you need to clone the existing repository to your local computer and then you can edit it.

Creating a Document Repository

If you are planning to edit an existing document, skip this section.

1. Navigate to the VideoRay-Documentation GitHub site. You will need to log in to view it.
2. Click New Repository in the top right corner. If you are not logged in or are not an Owner in the VideoRay Documentation group, this option will not appear and you will either need to log in or contact your supervisor.
3. Give the repository a name. The convention for repository naming is:
   1. All letters are lower case.
   2. Spaces are replaced with underscores.
   3. The name should provide a general idea of the document's contents.
4. Include an informative description of your project in the Description.
5. Leave the privacy setting on Public.
6. Check the box next to Initialize this Repository with a README.
7. Click Create Repository.

The repository exists on the GitHub server now, but it needs to be cloned to you local machine as well in order to work on it.

Cloning the Document Repository to Your Local Computer.

These steps apply to newly created project repositories as well as for preparing to edit an existing project that you have not yet configured locally.

1. Start SourceTree or your preferred Git client or use the command line. The following instructions assume you are using SourceTree
2. Click on the Clone/New button.
3. Enter the Source Path / URL: to the repository on GitHub:
     https://www.github.com/VideoRay-Documentation/repositoryName
   (replace repositoryName with the name of the desired repository).
4. Enter the Destination Path for the local copy of the repository:
     C:\VideoRay\www\repositoryName
   (replace repositoryName with the name of the desired repository). You can set up C:\\www\ as the default path in SourceTree.
5. Click the Clone button.
6. You may be prompted for your GitHub account credentials.

You should now have the repository (including its contents if editing) on your local machine. There are few more steps required to configure DynaDoc to work with this document. These steps are explained in the next section.