Git

Git is a version control and archiving platform. Files and changes to the files are stored in repositories. VideoRay uses private repositories on BitBucket to store DynaDoc and other proprietary utilities and public repositories on GitHub to store the document source (The source is the same as the published content, except in a different format, so it does not need to be protected).

Git Client

  1. Download and install SourceTree, or any other Git client.
  2. Other Git client choices can be found on the Git website.
  3. If you are familiar with using Git via the command line, you can use that as well.

BitBucket

You will need to clone the www repository from BitBucket before you can start creating documents.

  1. Visit BitBucket.
  2. Create an account if you don't already have one. Your username should be easily recognizable by other employees.
  3. Inform your supervisor of your account name, and have your permissions configured for the VideoRay Documentation team.
  4. Using BitBucket or SourceTree, Clone the www repository to your local computer in the following location: C:\www.

    If using SourceTree, click on the Clone/New button.

    1. Enter the Source Path / URL:, https://bitbucket.org/videoraydoc/www
    2. Enter the Destination Path using the location from above.
    3. You may be prompted for your BitBucket account credentials.

    If using BitBucket, navigate to the www repository on BitBucket.

    1. Click Clone in the Actions section of the sidebar (indicated by "...").
    2. Click on the Clone in SourceTree button.
    3. Allow the SourceTree application to launch.
    4. Enter Destination Path using the location from above.

GitHub

GitHub is required to clone a document set to your local computer for editing and to push documents back to GitHub for version control and archiving.

  1. Visit GitHub.
  2. Create an account if you don't already have one. Your username should be easily recognizable by other employees.
  3. Inform your supervisor of your account name, and have your permissions configured for the VideoRay Documentation group.

At this point, you will not need to access GitHub any further for preparing your environment. You will need to access GitHub when you start to work on documentation projects as explained in the Document Setup section.

Document Creation Manual, Version: 1.00.00
Copyright © 2022, VideoRay LLC - The Global Leader in Micro-ROV Technology