diff --git a/docs/further_reading/version_control.mdx b/docs/further_reading/version_control.mdx index 582f136d..82be5659 100644 --- a/docs/further_reading/version_control.mdx +++ b/docs/further_reading/version_control.mdx @@ -5,7 +5,10 @@ title: Version Control description: "Version control basics with Git and GitHub" --- -{/* TODO: Use path imports */} +import gitBasics from "../assets/further_reading/git_basics.png"; +import gitBranch from "../assets/further_reading/git_branch.png"; +import createPR from "../assets/further_reading/create_pull_request.png"; +import addReviewers from "../assets/further_reading/add_reviewers.png"; ## Git Overview @@ -13,19 +16,30 @@ Git is a version control system that enables you to track changes to files. With Nearly all operations that are performed by Git are in your local computing environment, with the exception of a few used to synchronize with the GitHub remote host. Some of the most common git operations are depicted below. -![Git basics](../assets/further_reading/git_basics.png) +Git basics If you would like to make any changes to current repository, it is always good to start with creating a feature branch, where you can save all the changes. -![Example branch](../assets/further_reading/git_branch.png) +Example branches diagram ## Create a Pull Request Pull requests are useful before you merge your branch with the main branch. You can request a review from your colleagues and check for any conflicts with the main branch. After you pushed all the changes to your branch, you can go to the original GitHub repository and click on the pull request. -![git pr](../assets/further_reading/create_pull_request.png) - -![git pr info](../assets/further_reading/add_reviewers.png) +Create a pull request +Add reviewers to a pull request ## Best Practices diff --git a/docs/quick_start.mdx b/docs/quick_start.mdx index 065cea1e..e7346f2a 100644 --- a/docs/quick_start.mdx +++ b/docs/quick_start.mdx @@ -13,6 +13,7 @@ import nvmrc from "./assets/nvmrc.png"; import template0 from "./assets/template_0.png"; import template1 from "./assets/template_1.png"; import workflowPermissions from "./assets/workflow-permissions.png"; +import powershellAdmin from "./assets/powershell_admin.png"; ## Creating Your Task Repository @@ -111,7 +112,10 @@ See [Prerequisites](prerequisites) for more information about these programs. 1. Run Powershell as an admin from the start menu - ![Powershell admin launcher](./assets/powershell_admin.png) + Powershell admin launcher 2. Navigate to the root directory of your cloned repository 3. Paste the following command and follow the prompts to install the listed programs: diff --git a/versioned_docs/version-3.2.x/quick_start.mdx b/versioned_docs/version-3.2.x/quick_start.mdx index dbc23189..51032be0 100644 --- a/versioned_docs/version-3.2.x/quick_start.mdx +++ b/versioned_docs/version-3.2.x/quick_start.mdx @@ -100,7 +100,7 @@ See [Prerequisites](prerequisites) for more information about these programs. 1. Run Powershell as an admin from the start menu - ![Powershell admin launcher](.//assets/powershell_admin.png) + ![Powershell admin launcher](./assets/powershell_admin.png) 2. Navigate to the root directory of your cloned repository 3. Paste the following command and follow the prompts to install the listed programs: