Skip to content

Commit

Permalink
ref: Use image imports whenever possible in current docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertGemmaJr committed Apr 24, 2024
1 parent 5a5114c commit 31b66e7
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 8 deletions.
26 changes: 20 additions & 6 deletions docs/further_reading/version_control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,41 @@ 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

Git is a version control system that enables you to track changes to files. With Git, you are able to revert files back to previous versions, restore deleted files, remove added files and even track down where a particular line of code was introduced.

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)
<img
src={gitBasics}
alt="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)
<img
src={gitBranch}
alt="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)
<img
src={createPR}
alt="Create a pull request"
/>
<img
src={addReviewers}
alt="Add reviewers to a pull request"
/>

## Best Practices

Expand Down
6 changes: 5 additions & 1 deletion docs/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
<img
src={powershellAdmin}
alt="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:
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.2.x/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 31b66e7

Please sign in to comment.