docs: Add workflow diagram to working_with_remotes.md assignment. #29446
Conversation
There was a problem hiding this comment.
I think this is a cool idea @AndresDev28, but there's one problem: your diagram doesn't render! See the comments below for how to fix it.
| ```mermaid | ||
| graph TD; | ||
| A[Upstream Repository: TheOdinProject/curriculum] -->|git fetch upstream/main| B[Local Repository: main]; | ||
| B -->|git checkout your_branch_name| C[Local Repository: your_branch_name]; | ||
| C -->|git push origin your_branch_name| D[Your Fork on GitHub]; | ||
| D -->|Create Pull Request to Upstream| E[Pull Request on GitHub]; | ||
| E -->|Maintainers Merge PR to Upstream| A[Upstream Repository: TheOdinProject/curriculum]; | ||
| ``` |
There was a problem hiding this comment.
This diagram doesn't render on the site properly. You can check that anything you're introducing renders properly by using our markdown preview tool.
To see the correct syntax for mermaid diagrams, look at the mermaid section of our LAYOUT_STYLE_GUIDE. This should get it to display properly.
There was a problem hiding this comment.
@JoshDevHub Thanks for pointing that out! I've reviewed the Mermaid section of the LAYOUT_STYLE_GUIDE and used the Markdown preview tool. I've wrapped the Mermaid diagram code in
tags in working_with_remotes.md and pushed the updated version. The diagram now renders correctly in the preview tool. Could you please take another look?
|
|
||
| Here is a visual representation of the workflow with Git and GitHub and illustrates how changes flow between repositories during collaboration. | ||
|
|
||
| <pre class="mermaid"> |
There was a problem hiding this comment.
| <pre class="mermaid"> | |
| <pre class="mermaid"> | |
| C -->|git push origin your_branch_name| D[Your Fork on GitHub]; | ||
| D -->|Create Pull Request to Upstream| E[Pull Request on GitHub]; | ||
| E -->|Maintainers Merge PR to Upstream| A[Upstream Repository: TheOdinProject/curriculum]; | ||
| </pre> |
There was a problem hiding this comment.
| </pre> | |
| </pre> |
| @@ -11,6 +11,21 @@ This section contains a general overview of topics that you will learn in this l | |||
| - Dangers of history-changing operations. | |||
| - Best practices of history-changing operations. | |||
|
|
|||
| ### Workflow Diagram | |||
There was a problem hiding this comment.
Heading needs to be sentence case
| ### Workflow Diagram | |
| ### Workflow diagram |
Because
This pull request adds a workflow diagram to the "Working with Remotes" assignment in the Intermediate Git course. The diagram visually represents the Git and GitHub collaboration workflow, making it easier for students to understand the steps involved in contributing to open-source projects. This enhancement aims to improve the clarity and educational value of the assignment.
This PR
working_with_remotes.mdassignment, placed after the "Lesson Overview" section.Issue
Closes #XXXXX
This PR does not close any specific issue. It is an enhancement to the learning material as part of a course assignment.
Additional Information
There was no prior Discord discussion for this enhancement.
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection