Skip to content

Commit 3bbe5c2

Browse files
author
DNN
committed
Commit latest build
1 parent 2884ca0 commit 3bbe5c2

7 files changed

Lines changed: 3739 additions & 3477 deletions

File tree

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

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>Edit an Article -- DNN Docs</title>
9+
<meta name="viewport" content="width=device-width">
10+
<meta name="title" content="Edit an Article -- DNN Docs">
11+
<meta name="generator" content="docfx ">
12+
13+
<link rel="shortcut icon" href="../../../../../favicon.ico">
14+
<link rel="stylesheet" href="../../../../../styles/docfx.vendor.css">
15+
<link rel="stylesheet" href="../../../../../styles/docfx.css">
16+
<link rel="stylesheet" href="../../../../../styles/dnndocs.css">
17+
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
18+
<link rel="preconnect" href="https://ZPKP9SED9P-dsn.algolia.net" crossorigin>
19+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha">
20+
<meta property="docfx:navrel" content="../../../../../toc.html">
21+
<meta property="docfx:tocrel" content="../../../toc.html">
22+
<meta property="og:title" content="Edit an Article -- DNN Docs">
23+
<meta property="og:image" content="../../../../../images/dnn_docs_logo.png">
24+
<meta property="og:description" content="Edit an Article -- DNN Docs">
25+
<meta property="og:url" content="https://docs.dnncommunity.org/content/getting-started/contribution/dnn-docs/how-to-edit-an-article/index.html">
26+
27+
28+
29+
<!-- Global site tag (gtag.js) - Google Analytics -->
30+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-137422488-1"></script>
31+
<script>
32+
window.dataLayer = window.dataLayer || [];
33+
function gtag(){dataLayer.push(arguments);}
34+
gtag('js', new Date());
35+
36+
gtag('config', 'UA-137422488-1');
37+
</script> </head>
38+
<body data-spy="scroll" data-target="#affix" data-offset="120">
39+
<div id="wrapper">
40+
<header>
41+
42+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
43+
<div class="container">
44+
<div class="navbar-header">
45+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
46+
<span class="sr-only">Toggle navigation</span>
47+
<span class="icon-bar"></span>
48+
<span class="icon-bar"></span>
49+
<span class="icon-bar"></span>
50+
</button>
51+
52+
<a class="navbar-brand" href="../../../../../index.html">
53+
<img id="logo" class="svg" src="../../../../../images/dnn_docs_logo.png" alt="">
54+
</a>
55+
</div>
56+
<div class="collapse navbar-collapse" id="navbar">
57+
<div class="navbar-right">
58+
<div id="docsearch-navbar" class="navbar-form navbar-right"></div>
59+
</div>
60+
</div>
61+
</div>
62+
</nav>
63+
64+
<div class="subnav navbar navbar-default">
65+
<div class="container">
66+
<div class="hide-when-search pull-left" id="breadcrumb">
67+
<ul class="breadcrumb">
68+
<li></li>
69+
</ul>
70+
</div>
71+
<div class="pull-right">
72+
<ul class="nav nav-pills">
73+
<li role="presentation dropdown">
74+
<a class="dropdown-toggle" id="shareMenu" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
75+
<i class="glyphicon glyphicon-share"></i> Share
76+
</a>
77+
<ul class="dropdown-menu" aria-labelledby="shareMenu">
78+
<li><a href="https://twitter.com/intent/tweet?original_referer=https%3A%2F%2Fdocs.dnncommunity.org%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.html&amp;text=Edit%20an%20Article%20%7C%20DNN%20Docs%20%7C%20%23DNNCMS&amp;tw_p=tweetbutton&amp;url=https%3A%2F%2Fdocs.dnncommunity.org%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.html" target="_blank"><i class="fab fa-twitter"></i> Twitter</a></li>
79+
<li><a href="https://www.linkedin.com/cws/share?url=https%3A%2F%2Fdocs.dnncommunity.org%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.html" target="_blank"><i class="fab fa-linkedin-in"></i> LinkedIn</a></li>
80+
<li><a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fdocs.dnncommunity.org%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.html" target="_blank"><i class="fab fa-facebook-square"></i> Facebook</a></li>
81+
<li role="separator" class="divider"></li>
82+
<li><a href="mailto:?subject=[Shared%20Article]%20Edit%20an%20Article%20|%20DNN%20Docs&amp;body=Edit%20an%20Article%20|%20DNN%20Docs%0A%0Ahttps%3A%2F%2Fdocs.dnncommunity.org%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.html%0A%0A"><i class="fas fa-envelope"></i> Email</a></li>
83+
</ul>
84+
</li>
85+
<li role="presentation">
86+
<a href="https://github.com/DNNCommunity/DNNDocs/issues/new?title=Feedback for Edit an Article&amp;body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23%23%23%23%20Document%20Details%0A%0A%E2%9A%A0%20*Do%20not%20edit%20this%20section.%20It%20is%20required%20for%20docs.dnncommunity.org%20%E2%9E%9F%20Core%20Team%20processing.*%0A%0A*%20Content%20Source%3A%20%5Bhow-to-edit-an-article%5D(https%3A%2F%2Fgithub.com%2FDNNCommunity%2FDNNDocs%2Fblob%2Fmain%2Fcontent%2Fgetting-started%2Fcontribution%2Fdnn-docs%2Fhow-to-edit-an-article%2Findex.md%2F%23L1)" target="_blank"><i class="glyphicon glyphicon-comment"></i> Feedback</a>
87+
</li>
88+
<li role="presentation">
89+
<a href="https://github.com/DNNCommunity/DNNDocs/blob/main/content/getting-started/contribution/dnn-docs/how-to-edit-an-article/index.md/#L1" target="_blank"><i class="glyphicon glyphicon-new-window"></i> Improve this Doc</a>
90+
</li>
91+
</ul>
92+
</div>
93+
</div>
94+
</div> </header>
95+
<div role="main" class="container body-content hide-when-search">
96+
97+
<div class="sidenav hide-when-search">
98+
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
99+
<div class="sidetoggle collapse" id="sidetoggle">
100+
<div id="sidetoc"></div>
101+
</div>
102+
</div>
103+
<div class="article row grid-right">
104+
<div class="col-md-10">
105+
<article class="content wrap" id="_content" data-uid="how-to-edit-an-article">
106+
<h1 id="edit-an-article">Edit an Article</h1>
107+
<div class="page-version">
108+
DNN Version: <span class="dnn-version">09.02.00</span>
109+
110+
</div>
111+
<div class="page-stats row visible-xs">
112+
<div class="pull-left">04/14/2026 &bull; 4 minutes to read</div>
113+
<div class="pull-left">Contributors&nbsp;
114+
<a href="https://github.com/GVskl" target="_blank">
115+
<img class="img-circle" src="https://avatars.githubusercontent.com/u/50699067?v=4" alt="GVskl">
116+
</a>
117+
<a href="https://github.com/david-poindexter" target="_blank">
118+
<img class="img-circle" src="https://avatars.githubusercontent.com/u/4568451?v=4" alt="david-poindexter">
119+
</a>
120+
</div>
121+
</div>
122+
<div class="page-stats row visible-sm visible-md visible-lg visible-xl">
123+
<span class="pull-left">04/14/2026</span>
124+
<span class="pull-left">&nbsp;&bull; 4 minutes to read</span>
125+
<span class="pull-left">&nbsp;&bull;&nbsp;Contributors&nbsp;
126+
<a href="https://github.com/GVskl" target="_blank">
127+
<img class="img-circle" src="https://avatars.githubusercontent.com/u/50699067?v=4" alt="GVskl">
128+
</a>
129+
<a href="https://github.com/david-poindexter" target="_blank">
130+
<img class="img-circle" src="https://avatars.githubusercontent.com/u/4568451?v=4" alt="david-poindexter">
131+
</a>
132+
</span>
133+
</div>
134+
135+
<h2 id="prerequisites">Prerequisites</h2>
136+
<ol>
137+
<li><p><strong>Get DNN Docs Running Locally</strong>: In order to edit an article you need to get DNN Docs running locally on your machine. Follow the steps on the <a class="xref" href="../get-dnn-docs-running-locally/index.html">Get DNN Docs Running Locally page</a> before proceeding.</p>
138+
</li>
139+
<li><p><strong>Markdown</strong>: Docs uses markdown syntax to format the docs files. Markdown is simple to pick up on. Familiarize yourself with the <a class="xref" href="../markdown-guide-to-docfx/index.html">Markdown Guide to DocFx</a> before making updates to content.</p>
140+
</li>
141+
</ol>
142+
<p>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.</p>
143+
<h2 id="steps-to-edit-an-article--create-a-pull-request">Steps to Edit an Article &amp; Create a Pull Request</h2>
144+
<ol>
145+
<li><p>Fork the <a href="https://github.com/DNNCommunity/DNNDocs">DNN Docs Repo</a> into your own Repo.
146+
<img src="/images/fork-screenshot.jpg" alt="Fork DNN Docs Screenshot"></p>
147+
</li>
148+
<li><p>Set your remote repositories. We will use the terms &quot;upstream&quot; and &quot;origin&quot;. When you originally cloned the repo (in the &quot;Getting DNN Docs Running Locally&quot; pre-requisite) the <code>origin</code> was added for you implicitly.</p>
149+
<p>Type <code>git remote add upstream https://github.com/DNNCommunity/DNNDocs</code> to add the main DNN Docs repo as your &quot;upstream&quot; repo</p>
150+
<div class="NOTE">
151+
<h5>Note</h5>
152+
<p>Remotes can be named anything you like. Find out your remotes by typing <code>git remote -v</code></p>
153+
</div>
154+
<p>Type <code>git remote -v</code> to list your remotes. If you are new to Git then you should have 2 remotes. Your <code>origin</code> and <code>upstream</code> where <code>origin</code> is your forked repo and your <code>upstream</code> is the main DNN Docs repo.</p>
155+
</li>
156+
<li><p>Create an <a href="https://github.com/DNNCommunity/DNNDocs/issues">Issue</a> on GitHub that corresponds with the edit you're working on by clicking the &quot;New Issue&quot; 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.</p>
157+
<p>Make note of the issue number that GitHub generates.</p>
158+
<p><img src="/images/git-issue-screenshot.jpg" alt="GitHub Issue Screenshot"></p>
159+
</li>
160+
<li><p>Create a new branch for your work. Typically branch names align with the issue number for ease of tracking.</p>
161+
<p><strong>Example Branch Name</strong>: <code>issue-107</code></p>
162+
<p><strong>Example Git Command to Create New Branch</strong>: <code>git checkout -b issue-107</code></p>
163+
</li>
164+
<li><p>Make your edits</p>
165+
</li>
166+
<li><p>Preview your work locally by invoking the <code>docfx --serve</code> in your terminal (in VS Code, Powershell, etc.). This will run DNN Docs locally on your machine at a URL similar to this <code>localhost:8080</code>. Click the link or copy/paste it into your browser.</p>
167+
</li>
168+
<li><p>Use <code>git status</code> to review the files you are working on and ensure the proper files are being tracked.
169+
<img src="/images/git-status-screenshot.jpg" alt="git status screenshot"></p>
170+
</li>
171+
<li><p>Use <code>git add [INSERT FILE NAME]</code> to stage a single file or <code>git add .</code> to stage <em>all</em> modified files to be committed.
172+
<img src="/images/git-add-screenshot.jpg" alt="git add screenshot"></p>
173+
</li>
174+
<li><p>Use <code>git commit -m [INSERT YOUR COMMIT MESSAGE HERE]</code> to commit your files. The <code>-m</code> stands for &quot;message&quot;. Replace the <em>INSERT YOUR COMMIT MESSAGE HERE</em> text with brief and relevant text summarizing your commit</p>
175+
</li>
176+
<li><p>Use <code>git push origin [INSERT A NEW BRANCH NAME HERE]</code> to push your updated files to your repo. Replace the <em>INSERT A NEW BRANCH NAME HERE</em> with the name of your new branch</p>
177+
</li>
178+
<li><p>Go to your forked GitHub repo on GitHub.com. GitHub should detect the updated code and prompt you to make a pull request.
179+
<img src="/images/git-compare-and-pull-request-screenshot.jpg" alt="Git compare and pull request screenshot"></p>
180+
</li>
181+
<li><p>Create a Pull Request by clicking the &quot;Compare and Create Pull Request&quot; button. In the description/comments section be sure to include the text &quot;Resolves <code>#[INSERT ISSUE NUMBER HERE]</code> where your previously created issue number is associated with this pull request.</p>
182+
<p><img src="/images/git-pull-request-resolves-screenshot.jpg" alt="Git pull request resolves"></p>
183+
</li>
184+
</ol>
185+
<div class="TIP">
186+
<h5>Tip</h5>
187+
<p>Want more info on Git? Check out the free, online <strong><a href="https://git-scm.com/book/en/v2">GitBook</a></strong></p>
188+
</div>
189+
</article>
190+
</div>
191+
192+
<div class="hidden-sm col-md-2" role="complementary">
193+
<div class="sideaffix">
194+
<div class="contribution">
195+
<ul class="nav">
196+
</ul>
197+
</div>
198+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
199+
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
200+
</nav>
201+
</div>
202+
</div>
203+
</div>
204+
</div>
205+
206+
<footer>
207+
<div class="grad-bottom"></div>
208+
<div class="footer">
209+
<div class="container">
210+
<span class="pull-right">
211+
<a href="#top">Back to top</a>
212+
</span>
213+
214+
<span>by the community, for the community... <strong>#DNNCMS</strong></span>
215+
</div>
216+
</div>
217+
</footer>
218+
</div>
219+
220+
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
221+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
222+
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.3.1/anchor.min.js"></script>
223+
<script type="text/javascript" src="../../../../../styles/docfx.vendor.min.js"></script>
224+
<script type="text/javascript" src="../../../../../styles/docfx.js"></script>
225+
<script type="text/javascript" src="../../../../../styles/main.js"></script>
226+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
227+
<script type="text/javascript">
228+
document.dnndocs = {
229+
algolia: function(selector) {
230+
return {
231+
container: selector,
232+
appId: 'ZPKP9SED9P',
233+
indexName: 'dnnsoftware',
234+
apiKey: '37bfc247275fb9e8fcecbda599134a30',
235+
}
236+
}
237+
};
238+
docsearch(document.dnndocs.algolia('#docsearch-navbar'));
239+
</script>
240+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
241+
242+
</body>
243+
</html>

‎docs/content/getting-started/contribution/dnn-docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,10 +137,10 @@ <h2 id="authoring--editing-content-in-dnn-docs">Authoring &amp; Editing Content
137137
<h3 id="editing-in-github">Editing in GitHub</h3>
138138
<p>If you are just updating text, typos, or adding a few sentences it may be easiest to edit the content directly from GitHub's browser. If you wish to edit directly in the browser check out the <a class="xref" href="how-to-edit-an-article-in-browser/index.html">Editing DNN Docs Online in GitHub</a>. Be sure to also check out the <a class="xref" href="markdown-guide-to-docfx/index.html">Markdown Guide to DocFX</a> to ensure you're formatting the code correctly.</p>
139139
<h3 id="editing-using-docfx">Editing Using DocFX</h3>
140-
<p>If you are making more complex edits you may want to <a class="xref" href="get-dnn-docs-running-locally/index.html">get DNN Docs running on your local machine</a>. In this case, after getting DNN Docs running locally, you'll follow the <a href="xref:how-to-edit-an-article">Editing DNN Docs Locally</a> guide.</p>
140+
<p>If you are making more complex edits you may want to <a class="xref" href="get-dnn-docs-running-locally/index.html">get DNN Docs running on your local machine</a>. In this case, after getting DNN Docs running locally, you'll follow the <a class="xref" href="how-to-edit-an-article/index.html">Editing DNN Docs Locally</a> guide.</p>
141141
<h2 id="helpful-links">Helpful Links</h2>
142142
<ul>
143-
<li><a href="xref:how-to-edit-an-article">How to Edit an Article</a></li>
143+
<li><a class="xref" href="how-to-edit-an-article/index.html">How to Edit an Article</a></li>
144144
<li><a class="xref" href="how-to-edit-source-code-comments/index.html">How to Edit Source Code Comments</a></li>
145145
<li><a class="xref" href="how-to-submit-a-new-topic/index.html">How to Submit a New Topic</a></li>
146146
<li><a class="xref" href="markdown-guide-to-docfx/index.html">Markdown Guide to DocFX</a></li>

‎docs/content/getting-started/toc.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797

9898
<ul class="nav level3">
9999
<li>
100-
<a href="contribution/dnn-docs/index.html" name="" title="Edit an Article">Edit an Article</a>
100+
<a href="contribution/dnn-docs/how-to-edit-an-article/index.html" name="" title="Edit an Article">Edit an Article</a>
101101
</li>
102102
<li>
103103
<a href="contribution/dnn-docs/how-to-edit-an-article-in-browser/index.html" name="" title="Edit an Article in the Browser">Edit an Article in the Browser</a>

0 commit comments

Comments
 (0)