Edit an Article
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 before proceeding.
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 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.
Steps to Edit an Article & Create a Pull Request
Fork the DNN Docs Repo into your own Repo.
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
originwas added for you implicitly.
git remote add upstream https://github.com/DnnSoftwarePersian/DNNDocsto add the main DNN Docs repo as your "upstream" repo
Remotes can be named anything you like. Find out your remotes by typing
git remote -v
git remote -vto list your remotes. If you are new to Git then you should have 2 remotes. Your
originis your forked repo and your
upstreamis the main DNN Docs repo.
Create an Issue 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.
Create a new branch for your work. Typically branch names align with the issue number for ease of tracking.
Example Branch Name:
Example Git Command to Create New Branch:
git checkout -b issue-107
Make your edits
Preview your work locally by invoking the
docfx --servein your terminal (in VS Code, Powershell, etc.). This will run DNN Docs locally on your machine at a URL similar to this
localhost:8080. Click the link or copy/paste it into your browser.
git statusto review the files you are working on and ensure the proper files are being tracked.
git add [INSERT FILE NAME]to stage a single file or
git add .to stage all modified files to be committed.
git commit -m [INSERT YOUR COMMIT MESSAGE HERE]to commit your files. The
-mstands for "message". Replace the INSERT YOUR COMMIT MESSAGE HERE text with brief and relevant text summarizing your commit
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
Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
Create a Pull Request by clicking the "Compare and Create Pull Request" button. In the description/comments section be sure to incoude the text "Resolves
#[INSERT ISSUE NUMBER HERE]where your previously created issue number is associated with this pull request.
Want more info on Git? Check out the free, online GitBook