Skip to content

Commit ab2e1d5

Browse files
authored
Update in follow up from comments, remarks and suggestions on Pull Request
1 parent ec70faa commit ab2e1d5

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

  • content/getting-started/contribution/dnn-docs/how-to-edit-an-article

content/getting-started/contribution/dnn-docs/how-to-edit-an-article/index.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,38 +57,39 @@ Now that you've gotten DNN Docs running locally (congrats BTW!) we will talk thr
5757

5858
9. Use ```git commit -m [INSERT YOUR COMMIT MESSAGE HERE]``` to commit your files. The ```-m``` stands for "message". Replace the *INSERT YOUR COMMIT MESSAGE HERE* text with brief and relevant text summarizing your commit
5959
10. Use ```git push origin [INSERT A NEW BRANCH NAME HERE]``` to push your updated files to your remote repo (on Github with name ```origin```). Replace the *INSERT A NEW BRANCH NAME HERE* with the name of your new branch. In this example ```issue-107```
60-
Go to step 11. below.
60+
11. Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
61+
![Git compare and pull request screenshot](/images/GitHub_InBrowser_CompareAndPullRequest.jpg)
62+
63+
12. Create a Pull Request on Github.com by clicking the "Compare and Create Pull Request" button. In the description/comments section be sure to include the text "Resolves ```#[INSERT ISSUE NUMBER HERE]``` where your previously created issue number is associated with this pull request.
64+
65+
![Git pull request resolves](/images/GitHub_InBrowser_PullRequestResolves.jpg)
66+
6167

6268

6369
## Steps to Edit an Article & Create a Pull Request using Visual Studio
6470
1. Cloning the repository from Visual Studio, as described on [Get DNN Docs Running Locally page](xref:get-dnn-docs-running-locally), has forked the [DNN Docs Repo](https://github.com/DNNCommunity/DNNDocs) into your own Repo on Github.
65-
2. Step 'Set your remote repositories' is (at this moment) not necessary.
66-
3. Create an [Issue](https://github.com/DNNCommunity/DNNDocs/issues) on GitHub that corresponds with the edit you're working on by clicking the "New Issue" button in the browser. Be sure to include relevant information providing context to the issue in the description/comment section. This helps reviewers understand what you're working on.
71+
2. Create an [Issue](https://github.com/DNNCommunity/DNNDocs/issues) on GitHub that corresponds with the edit you're working on by clicking the "New Issue" button in the browser. Be sure to include relevant information providing context to the issue in the description/comment section. This helps reviewers understand what you're working on.
6772

6873
Make note of the issue number that GitHub generates.
6974

7075
![GitHub Issue Screenshot](/images/GitHub_InBrowser_Issue.jpg)
71-
4. Create a new branch for your work using Visual Studio menu item 'Git...New Branch..'
76+
3. Create a new branch for your work using Visual Studio menu item 'Git...New Branch..'
7277
![Visual Studio 2026 Create New Branch](/images/DnnDocs_VS2026_CreateNewBranch.png)
7378
For more elaborate instructions on how to create a new branch in Visual Studio see https://learn.microsoft.com/en-us/visualstudio/version-control/git-create-branch?view=visualstudio.
74-
5. Make your edits
75-
6. & 7. & 8. Preview your work and files locally using the 'Git Changes' tab in Visual Studio.
79+
4. Make your edits
80+
5. Preview your work and files locally using the 'Git Changes' tab in Visual Studio.
7681
![Visual Studio 2026 Git Changes Tab](/images/DnnDocs_VS2026_GitChangesTab.png)
77-
9. & 10. Commit the changed and added files by clicking 'Commit All and Push'.
82+
6. Commit the changed and added files by clicking 'Commit All and Push'.
7883
![Visual Studio 2026 Commit Changes](/images/DnnDocs_VS2026_GitChanges_CommitAllAndPush.png)
79-
80-
81-
82-
## Common Steps to Edit an Article & Create a Pull Request (for both Git and Visual Studio)
83-
11. Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
84+
7. Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
8485
![Git compare and pull request screenshot](/images/GitHub_InBrowser_CompareAndPullRequest.jpg)
8586

86-
12. Create a Pull Request on Github.com by clicking the "Compare and Create Pull Request" button. In the description/comments section be sure to include the text "Resolves ```#[INSERT ISSUE NUMBER HERE]``` where your previously created issue number is associated with this pull request.
87+
8. Create a Pull Request on Github.com by clicking the "Compare and Create Pull Request" button. In the description/comments section be sure to include the text "Resolves ```#[INSERT ISSUE NUMBER HERE]``` where your previously created issue number is associated with this pull request.
8788

8889
![Git pull request resolves](/images/GitHub_InBrowser_PullRequestResolves.jpg)
8990

9091

9192

9293

9394
> [!TIP]
94-
> Want more info on Git? Check out the free, online **[GitBook](https://git-scm.com/book/en/v2)**
95+
> Want more info on Git? Check out the free, online **[GitBook](https://git-scm.com/book/en/v2)**

0 commit comments

Comments
 (0)