Skip to content

Add Visual Studio as an alternative to edit DNN Docs articles. Additionally… #793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GVskl wants to merge 2 commits into
base: main
Choose a base branch
from
+77 −28
Open

Add Visual Studio as an alternative to edit DNN Docs articles. Additionally… #793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee09121
Add Visual Studio as an alternative to edit articles. Additionally ad…
GVskl Apr 16, 2026
ec70faa
Merge branch 'main' into FlattenLearningCurve_and_AddVisualStudio
GVskl Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ If you made some changes before making a branch (you are on branch **main** and
git switch -c your-branch-name
```

Next you can start editing documentation and saving files using your favorite text editor (Visual Studio Code, Atom, Sublime Text, Brackets Notedpad++, etc). When you are done with your changes you can verify the modified files. Some code editors will actually show a status of the modified files in their UI. If you want to verify it using the command line you can run the following command:
Next you can start editing documentation and saving files using your favorite text editor (Visual Studio Code, Atom, Sublime Text, Brackets/Phoenix Code, Notepad++, etc). When you are done with your changes you can verify the modified files. Some code editors will actually show a status of the modified files in their UI. If you want to verify it using the command line you can run the following command:

```
git status
Expand All @@ -122,7 +122,8 @@ Congratulations, you have created your first commit! The next step is to push yo
git push -u origin your-branch-name
```

Now your changes are available in your **fork** of the repository for anyone to view. Remember how you only have read access to the **upstream** (or offical repository)? Since we cannot push there, they need to pull. The next and last step is to propose your changes, or in other works, request from DNNDocs team to **pull** your changes, hence the name **pull request**. You can create a **pull request** directly in the browser, if you navigate the the origin or the upstream repositories any soon, you will see a banner showing the recent pushes and a button to create a pull request. If for some reason you do not see that banner, navigate to your fork and select your branch in the branches dropdown, you will see a "Create Pull Request" button.
Now your changes are available in your **fork** of the repository for anyone to view. Remember how you only have read access to the **upstream** (or offical repository)? Since we cannot push there, they need to pull. The next and last step is to propose your changes, or in other works, request the DNNDocs team to **pull** your changes, hence the name **pull request**. You can create a **pull request** directly in the browser, if you navigate to the origin or the upstream repositories soon you will see a banner showing the recent pushes and a button to create a pull request. If for some reason you do not see that banner, navigate to your fork and select your branch in the branches dropdown, you will see a "Create Pull Request" button.
![Create Pull Request Button](/images/GitHub_InBrowser_PullRequestButton.jpg)

**Congratulations, you just created your first pull request!**

Expand Down
38 changes: 31 additions & 7 deletions ...ent/getting-started/contribution/dnn-docs/get-dnn-docs-running-locally/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,24 @@
uid: get-dnn-docs-running-locally
locale: en
title: Get DNN Docs Running Locally
dnnversion: 09.02.00
dnnversion: 10.02.00
---

# Get DNN Docs Running Locally

The project uses the `docfx` library to pull XML comments from the DNN Platform source code and combine that with articles written in Markdown to form the documentation for DNN.

## Installing Git
This page first explains how to use Git in contributing to DNN Docs. The second and last part does the same for Visual Studio.

## Using Git

### Installing Git
If you do not have Git installed you will need to install Git first. You can find instructions on installing Git from [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

## Installing dotnet
### Installing dotnet
Our cross-platform build scripts handle obtaining docfx for you, however you will need to have the latest .net SDK installed. [Download .NET](https://dotnet.microsoft.com/en-us/download)

## Setting Up the DNN Docs Project
### Setting Up the DNN Docs Project
The next step is to clone this repo. 'Cloning the repo' will simply create a copy of the repo (files and folders) on your local machine so that you can work with them.

Note the following example command clones the repo to the location of `c:\dev`. Update the `c:\dev` location to your location of choice on your machine.
Expand All @@ -28,7 +32,7 @@ The previous command will have created a folder called `DNNDocs` in the `c:\dev`
c:\dev> cd DNNDocs
```

## Running the DNN Docs Project Locally
### Running the DNN Docs Project Locally
You should now be able to run the development version of the docs locally with the following command:

```
Expand All @@ -52,9 +56,29 @@ Open that page up in your browser to see the documentation.

[http://localhost:8080](http://localhost:8080)

### Optional git integrations
#### Optional git integrations
We use a handful of plugins that will not work unless you have a valid authentication to github REST APIs. This step is optional but if not performed, you won't get some of the features like displaying contributors on pages. If you need to work in that area you will need to [Setup a git personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). Once that is created, copy your token (you will only view it once) and create a `.env` file at the root of the project with a line like this (everything after the `=` sign is the token you copied).

```
GithubToken=github_pat_xxxxxxxxxx
```
```

## Using Microsoft Visual Studio

The following tutorial explains how to set DNN Docs Project up locally using Visual Studio 2026.
As 'Repository location' use https://github.com/DNNCommunity/DNNDocs.git
![Repository Location Screenshot](/images/DnnDocs_VS2026_CloneRepository.png)

- Clone a Git repository in Visual Studio
https://learn.microsoft.com/en-us/visualstudio/version-control/git-clone-repository?view=visualstudio

Adjust the Push configuration for the DNN Docs Git repository to point to your fork/branch of the DNN Docs repoisitory on Github. Note the <YourGitHubUserName> part.
![Visual Studio 2026 Commit Changes](/images/DnnDocs_VS2026_ManageRemotes1.png)
![Visual Studio 2026 Commit Changes](/images/DnnDocs_VS2026_ManageRemotes2.png)
![Visual Studio 2026 Commit Changes](/images/DnnDocs_VS2026_ManageRemotes3.png)

After having set up DNN Docs in the 'Solution Explorer' switch to 'Folder View'.
![Solution Explorer Folder View Screenshot](/images/DnnDocs_VS2026_SolutionExplorer_Views.png)

Under the 'content' branch / folder you will find (the content of) the DNN Docs.
![Content Folder View Screenshot](/images/DnnDocs_VS2026_SolutionExplorer_FolderView.png)
8 changes: 4 additions & 4 deletions ...etting-started/contribution/dnn-docs/how-to-edit-an-article-in-browser/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
uid: how-to-edit-an-article-in-browser
locale: en
title: Edit an Article in the Browser
dnnversion: 09.02.00
dnnversion: 10.02.00
---

# Edit an Article in the Browser
Expand All @@ -14,16 +14,16 @@ The easiest way to edit a DNN Doc file is to edit it in the browser on GitHub.co

2. Click the ```Edit``` button icon.

![Edit article in browser](/images/edit-article-in-browser.jpg)
![Edit article in browser](/images/GitHub_InBrowser_EditArticle.jpg)



3. Edit the markdown as needed, opt to "Create a New Branch", and propose the change.

![Edit Markdown in browser](/images/in-browser-pull-request.gif)
![Edit Markdown in browser](/images/GitHub_InBrowser_PullRequest1.gif)



4. Update the title & submit the Pull Request

![Edit Markdown in browser](/images/In-Browser-Pull-Request-2.gif)
![Edit Markdown in browser](/images/GitHub_InBrowser_PullRequest2.gif)
51 changes: 37 additions & 14 deletions content/getting-started/contribution/dnn-docs/how-to-edit-an-article/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,41 @@
uid: how-to-edit-an-article
locale: en
title: Edit an Article
dnnversion: 09.02.00
dnnversion: 10.02.00
related-topics:
---

# Edit an Article
# Edit an Article (running DNN Docs Locally on Your Machine)

## Prerequisites
1. **Get DNN Docs Running Locally**: In order to edit an article you need to get DNN Docs running locally on your machine. Follow the steps on the [Get DNN Docs Running Locally page](xref:get-dnn-docs-running-locally) before proceeding.

2. **Markdown**: Docs uses markdown syntax to format the docs files. Markdown is simple to pick up on. Familiarize yourself with the [Markdown Guide to DocFx](xref:markdown-guide-to-docfx) before making updates to content.


Now that you've gotten DNN Docs running locally (congrats BTW!) we will talk through the steps for making an edit, previewing the edit, pushing it to your forked repo, then creating a Pull Request.
Now that you've gotten DNN Docs running locally (congrats BTW!) we will talk through the steps for making an edit (in your local repo), previewing the (local) edit, pushing it to your forked repo (on the Github.com website), then creating a Pull Request on the Github.com website. First using Git; second using Visual Studio.

## Steps to Edit an Article & Create a Pull Request
## Steps to Edit an Article & Create a Pull Request using Git

1. Fork the [DNN Docs Repo](https://github.com/DNNCommunity/DNNDocs) into your own Repo.
![Fork DNN Docs Screenshot](/images/fork-screenshot.jpg)
1. Fork the [DNN Docs Repo](https://github.com/DNNCommunity/DNNDocs) into your own Repo on Github.
![Fork DNN Docs Screenshot](/images/GitHub_InBrowser_ForkDnnDocs.jpg)



2. Set your remote repositories. We will use the terms "upstream" and "origin". When you originally cloned the repo (in the "Getting DNN Docs Running Locally" pre-requisite) the ```origin``` was added for you implicitly.
2. Set your remote repositories. We will use the terms "upstream" and "origin". Note: when you originally cloned the repo locally (in the "Getting DNN Docs Running Locally" pre-requisite) the locally cloned repo was named ```origin``` implicitly (as well).

Type ```git remote add upstream https://github.com/DNNCommunity/DNNDocs``` to add the main DNN Docs repo as your "upstream" repo

> [!NOTE]
> Remotes can be named anything you like. Find out your remotes by typing ```git remote -v```

Type ```git remote -v``` to list your remotes. If you are new to Git then you should have 2 remotes. Your ```origin``` and ```upstream``` where ```origin``` is your forked repo and your ```upstream``` is the main DNN Docs repo.
Type ```git remote -v``` to list your remotes. If you are new to Git then you should have 2 remotes. Your ```origin``` and ```upstream``` where ```origin``` is your forked repo and your ```upstream``` is the main DNN Docs repo; both on Github.

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.

Make note of the issue number that GitHub generates.

![GitHub Issue Screenshot](/images/git-issue-screenshot.jpg)
![GitHub Issue Screenshot](/images/GitHub_InBrowser_Issue.jpg)


4. Create a new branch for your work. Typically branch names align with the issue number for ease of tracking.
Expand All @@ -56,16 +56,39 @@ Now that you've gotten DNN Docs running locally (congrats BTW!) we will talk thr


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
10. Use ```git push origin [INSERT A NEW BRANCH NAME HERE]``` to push your updated files to your repo. Replace the *INSERT A NEW BRANCH NAME HERE* with the name of your new branch
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```
Go to step 11. below.


## Steps to Edit an Article & Create a Pull Request using Visual Studio
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.
2. Step 'Set your remote repositories' is (at this moment) not necessary.
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.

Make note of the issue number that GitHub generates.

![GitHub Issue Screenshot](/images/GitHub_InBrowser_Issue.jpg)
4. Create a new branch for your work using Visual Studio menu item 'Git...New Branch..'
![Visual Studio 2026 Create New Branch](/images/DnnDocs_VS2026_CreateNewBranch.png)
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.
5. Make your edits
6. & 7. & 8. Preview your work and files locally using the 'Git Changes' tab in Visual Studio.
Copy link
Copy Markdown
Member

@valadas valadas Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason why 6 & 7 & 8 here? If I understand correctly its is because 1-10 are different if using VisualStudio or not, but then 11 is common. If so maybe it should be broken down as I find that confusiong...

Copy link
Copy Markdown
Contributor Author

@GVskl GVskl Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Prerequisites Steps and steps 11 and 12 are identical for Git and Visual Studio. The first 10 steps are conceptually the same, but in what to do (in Git versus Visual Studio) different. That apparently is not clear enough. I will split up Git and Visual Studio completely.
I'm quite new to Git. Shall I checkout the same branch the pull request is based on and push to it again?

Copy link
Copy Markdown
Member

@valadas valadas Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you can push additional commits to this branch which will update this Pull Request

![Visual Studio 2026 Git Changes Tab](/images/DnnDocs_VS2026_GitChangesTab.png)
9. & 10. Commit the changed and added files by clicking 'Commit All and Push'.
![Visual Studio 2026 Commit Changes](/images/DnnDocs_VS2026_GitChanges_CommitAllAndPush.png)



## Common Steps to Edit an Article & Create a Pull Request (for both Git and Visual Studio)
11. Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
![Git compare and pull request screenshot](/images/git-compare-and-pull-request-screenshot.jpg)
![Git compare and pull request screenshot](/images/GitHub_InBrowser_CompareAndPullRequest.jpg)

12. Create a Pull Request 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.
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.

![Git pull request resolves](/images/git-pull-request-resolves-screenshot.jpg)
![Git pull request resolves](/images/GitHub_InBrowser_PullRequestResolves.jpg)




> [!TIP]
> Want more info on Git? Check out the free, online **[GitBook](https://git-scm.com/book/en/v2)**
> Want more info on Git? Check out the free, online **[GitBook](https://git-scm.com/book/en/v2)**
3 changes: 2 additions & 1 deletion content/getting-started/contribution/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
uid: getting-started-contribution
locale: en
title: DNN Contribution
dnnversion: 09.05.00
dnnversion: 10.02.00
---

# DNN Contribution
Expand All @@ -15,3 +15,4 @@ Learn the basic steps for [contributing to the **DNN Platform** project on GitHu
Learn the basic steps for contributing to the **DNN Docs** project on GitHub, which powers **docs.dnncommunity.org**.

Please click the **Improve this Doc** button above to help us improve this page.
![Improve this Doc Screenshot](/images/GitHub_InBrowser_ImproveThisDoc.png)
Binary file added images/DnnDocs_VS2026_CloneRepository.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_CreateNewBranch.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_GitChangesTab.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_GitChanges_CommitAllAndPush.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_ManageRemotes1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_ManageRemotes2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_ManageRemotes3.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_SolutionExplorer_FolderView.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DnnDocs_VS2026_SolutionExplorer_Views.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...t-compare-and-pull-request-screenshot.jpg → ...itHub_InBrowser_CompareAndPullRequest.jpg
View file
Open in desktop
Copy link
Copy Markdown
Member

@valadas valadas Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

7 image files where renamed, was it verified that they were not used by other articles? If not, I would prefer to avoid the renaming.

Copy link
Copy Markdown
Contributor Author

@GVskl GVskl Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked and just now rechecked if there were any references in DNN Docs to the following files:

  • git-compare-and-pull-request-screenshot.jpg
  • edit-article-in-browser.jpg
  • fork-screenshot.jpg
  • git-issue-screenshot.jpg
  • in-browser-pull-request.gif
  • In-Browser-Pull-Request-2.gif
  • git-pull-request-resolves-screenshot.jpg
    I couldn't find any.
    I changed the file names to OOP-like naming because it clusters related files which reduces the chance of duplicating files and keeping files that are not used anymore.

3 OTHER files only are mentioned in the manifest.json. To my knowledge that means they are not actively used. Would you like me to create a pull request deleting those?

Copy link
Copy Markdown
Member

@valadas valadas Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it is not related to this change, I would leave the files and place and optionally do another PR if you want to delete unused files.

Copy link
Copy Markdown
Contributor Author

@GVskl GVskl Jun 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is and it isn't related to this change. I've added a couple of screenshots in the DNN Doc articles in which these existing screenshots are used as well. And in doing so aligned the naming of the files (using the original file names), thus clustering them. See screenshot underneath.

DNNDocs_ImagesRename_ScreenShot

Would you mind having the name changes included? I'm more than happy to do some extra checks.

File renamed without changes
0 images/edit-article-in-browser.jpg → images/GitHub_InBrowser_EditArticle.jpg
View file
Open in desktop
File renamed without changes
0 images/fork-screenshot.jpg → images/GitHub_InBrowser_ForkDnnDocs.jpg
View file
Open in desktop
File renamed without changes
Binary file added images/GitHub_InBrowser_ImproveThisDoc.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 images/git-issue-screenshot.jpg → images/GitHub_InBrowser_Issue.jpg
View file
Open in desktop
File renamed without changes
0 images/in-browser-pull-request.gif → images/GitHub_InBrowser_PullRequest1.gif
View file
Open in desktop
File renamed without changes
0 images/In-Browser-Pull-Request-2.gif → images/GitHub_InBrowser_PullRequest2.gif
View file
Open in desktop
File renamed without changes
Binary file added images/GitHub_InBrowser_PullRequestButton.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 .../git-pull-request-resolves-screenshot.jpg → .../GitHub_InBrowser_PullRequestResolves.jpg
View file
Open in desktop
File renamed without changes
Loading