Waypoint Ventures documentation

• Welcome
• Quick start
• Quick start
• Install software
• Set Git credentials
• Install Git client
• Install Git History extension
• Install Azure Repos extension
• Install Pull Requests extension
• Install Word Count extension
• Install Docs Authoring Pack
• Install Visual Studio Code
• Workflow and processes
• Test process
• Content editing process
• Instructional design review process
• Technical review process
• Authoring process
• General project workflow
• Terminology and concepts
• View/ download course files
• Fetch upstream changes
• Clone single folder
• Fix cloning errors
• Download course files (clone repo)
• Fork a repository
• View course files in web browser
• Working on branches
• Recover deleted branch
• Delete branch
• Rename branch
• Send (push) files
• Switch branches in VSC
• Update branch (pull) in VSC
• Create new branch in VSC
• Project branching policies
• Add/ edit content
• Create scaffolding
• Invite collaborator
• Fix linter issues
• Use author outlines
• Create new markdown file in VSC
• Add/ edit images in VSC
• Add/ edit markdown in VSC
• Add/ edit content in web browser
• Markdown syntax guide
• Pull requests and reviews
• Resolve merge conflicts
• Merge a pull request
• Work in a pull request
• Create pull request
• Pull requests overview
• Prepublication preparations
• Style a doc in Word
• Configure styles in Word
• Convert markdown to doc
• Setup file conversion tools
• About prepublication
• Appendices
• Links to useful resources
• Glossary
• FAQ
• Best practices guide

In this guide, you will download (or clone) a copy of the course files from GitHub to your computer.

Topics in this guide

• Clone the GitHub repo

Clone the GitHub repo

Complete the following steps to download (clone) the project’s repo from GitHub.

1. Open a web browser. Go to https://github.com, and sign into GitHub.

2. Go to the project’s GitHub repo at https://github.com/WaypointVentures/<project repo name>, where <project repo name> refers to the name of the project you are working on.

   For example, for the “Az Funds” project, go to https://github.com/WaypointVentures/azfundedu.

3. Use the dropdown to choose the master branch, then select the green Clone or download button. Copy the GitHub clone URL by using the copy icon beside the URL, as shown in the following image.

   

4. On your computer, open VSC and go to View > Command Palette. Type git clone into the dialogue box.

   

   Note: You can run other Git commands within the VSC command palette. Not all Git commands are available from the VSC command palette. Use the VSC Terminal to access more Git commands.

   The subset of Git commands available from the VSC command palette should be sufficient for the current project. For help with scenarios not covered by the VSC command palette, ask your project manager.

5. Select the git clone command from the list. In the Repository URL dialogue, paste in the GitHub clone URL you copied previously, then press Enter.

   

6. A Select Folder window will appear. Inside the Select Folder window, set a location on your computer where you want to save your copy of the GitHub repo, then choose Select Repository Location.

   Save a copy of the GitHub repo wherever you prefer.

   Note: Saving the GitHub repo to remote storage, such as OneDrive, is not recommended. Remote storage typically uses longer file paths, which may cause problems. Clone the GitHub repo to local storage (i.e. on your computer) instead.

   

7. A progress indicator will appear in the bottom left corner of VSC. When it finishes VSC will prompt you to open the repo you cloned.

   

   

8. Choose Open. The (locally) cloned repo will open in VSC on the master branch.

   You can reopen the local repo at anytime in VSC using File > Open Folder…. The local repo will be displayed in the VSC folder view (side bar).

   Note: A copy of the files and folders from GitHub are now present on your computer. Your copy is an exact match of the GitHub repo.

You have cloned the GitHub repo successfully!