You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ If you made some changes before making a branch (you are on branch **main** and
96
96
git switch -c your-branch-name
97
97
```
98
98
99
-
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:
99
+
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:
100
100
101
101
```
102
102
git status
@@ -122,7 +122,8 @@ Congratulations, you have created your first commit! The next step is to push yo
122
122
git push -u origin your-branch-name
123
123
```
124
124
125
-
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.
125
+
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.
Copy file name to clipboardExpand all lines: content/getting-started/contribution/dnn-docs/get-dnn-docs-running-locally/index.md
+31-7Lines changed: 31 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,24 @@
2
2
uid: get-dnn-docs-running-locally
3
3
locale: en
4
4
title: Get DNN Docs Running Locally
5
-
dnnversion: 09.02.00
5
+
dnnversion: 10.02.00
6
6
---
7
7
8
8
# Get DNN Docs Running Locally
9
9
10
10
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.
11
11
12
-
## Installing Git
12
+
This page first explains how to use Git in contributing to DNN Docs. The second and last part does the same for Visual Studio.
13
+
14
+
## Using Git
15
+
16
+
### Installing Git
13
17
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)
14
18
15
-
## Installing dotnet
19
+
###Installing dotnet
16
20
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)
17
21
18
-
## Setting Up the DNN Docs Project
22
+
###Setting Up the DNN Docs Project
19
23
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.
20
24
21
25
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.
@@ -28,7 +32,7 @@ The previous command will have created a folder called `DNNDocs` in the `c:\dev`
28
32
c:\dev> cd DNNDocs
29
33
```
30
34
31
-
## Running the DNN Docs Project Locally
35
+
###Running the DNN Docs Project Locally
32
36
You should now be able to run the development version of the docs locally with the following command:
33
37
34
38
```
@@ -52,9 +56,29 @@ Open that page up in your browser to see the documentation.
52
56
53
57
[http://localhost:8080](http://localhost:8080)
54
58
55
-
### Optional git integrations
59
+
####Optional git integrations
56
60
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).
57
61
58
62
```
59
63
GithubToken=github_pat_xxxxxxxxxx
60
-
```
64
+
```
65
+
66
+
## Using Microsoft Visual Studio
67
+
68
+
The following tutorial explains how to set DNN Docs Project up locally using Visual Studio 2026.
69
+
As 'Repository location' use https://github.com/DNNCommunity/DNNDocs.git
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.
76
+
77
+
78
+
79
+
80
+
After having set up DNN Docs in the 'Solution Explorer' switch to 'Folder View'.
81
+
82
+
83
+
Under the 'content' branch / folder you will find (the content of) the DNN Docs.
Copy file name to clipboardExpand all lines: content/getting-started/contribution/dnn-docs/how-to-edit-an-article/index.md
+39-13Lines changed: 39 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,41 +2,41 @@
2
2
uid: how-to-edit-an-article
3
3
locale: en
4
4
title: Edit an Article
5
-
dnnversion: 09.02.00
5
+
dnnversion: 10.02.00
6
6
related-topics:
7
7
---
8
8
9
-
# Edit an Article
9
+
# Edit an Article (running DNN Docs Locally on Your Machine)
10
10
11
11
## Prerequisites
12
12
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.
13
13
14
14
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.
15
15
16
16
17
-
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.
17
+
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.
18
18
19
-
## Steps to Edit an Article & Create a Pull Request
19
+
## Steps to Edit an Article & Create a Pull Request using Git
20
20
21
-
1. Fork the [DNN Docs Repo](https://github.com/DNNCommunity/DNNDocs) into your own Repo.
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.
26
+
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).
27
27
28
28
Type ```git remote add upstream https://github.com/DNNCommunity/DNNDocs``` to add the main DNN Docs repo as your "upstream" repo
29
29
30
30
> [!NOTE]
31
31
> Remotes can be named anything you like. Find out your remotes by typing ```git remote -v```
32
32
33
-
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.
33
+
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.
34
34
35
35
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.
36
36
37
37
Make note of the issue number that GitHub generates.
4. Create a new branch for your work. Typically branch names align with the issue number for ease of tracking.
@@ -56,13 +56,39 @@ Now that you've gotten DNN Docs running locally (congrats BTW!) we will talk thr
56
56
57
57
58
58
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
59
-
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
59
+
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
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
-
61
+
62
62
63
-
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.
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.
## Steps to Edit an Article & Create a Pull Request using Visual Studio
70
+
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.
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.
72
+
73
+
Make note of the issue number that GitHub generates.
3. Create a new branch for your work using Visual Studio menu item 'Git...New Branch..'
77
+
78
+
79
+
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.
80
+
6. Make your edits.
81
+
7. Preview your work and files locally using the 'Git Changes' tab in Visual Studio.
82
+
83
+
84
+
8. Commit the changed and added files by clicking 'Commit All and Push'.\
85
+
86
+
9. Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
87
+
88
+
89
+
10. 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.
0 commit comments