forked from NASA-PDS/nasa-pds.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpds_sw_docs.html
334 lines (212 loc) · 14.1 KB
/
pds_sw_docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PDS Software Documentation Best Practices — NASA PDS Software documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Search Engine Optimization" href="seo.html" />
<link rel="prev" title="PDS Continuous Integration / Continuous Deployment" href="pds_ci_cd.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> NASA PDS Software
<img src="../_static/PDS_Planets.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">System Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../releases_bkp/release.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="../releases_bkp/plan.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">Developer Guides`</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="pds_git_and_github_guide.html">PDS Git and Github Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="pds_issue_tracking_guide.html">PDS Issue Tracking</a></li>
<li class="toctree-l1"><a class="reference internal" href="pds_ci_cd.html">PDS Continuous Integration / Continuous Deployment</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">PDS Software Documentation Best Practices</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#purpose">Purpose</a></li>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#general-requirements">General Requirements</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#pds-shall-only-host-online-the-latest-version-of-software-documentation">PDS shall only host online the latest version of software documentation.</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pds-shall-host-software-documentation-on-github-pages-for-all-open-source-repositories">PDS shall host software documentation on Github Pages for all Open Source repositories</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pds-shall-generate-a-documentation-package-with-each-release-and-upload-to-github-release-assets">PDS shall generate a documentation package with each release and upload to Github Release Assets.</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pds-shall-generate-a-past-releases-page-for-each-software-tool-which-includes-links-to-the-source-code-download-package-and-documentation">PDS shall generate a Past Releases page for each software tool, which includes links to the source code / download package and documentation.</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#pds-shall-include-at-minimum-the-following-documentation-pages-installation-usage-or-operation-developer-support">PDS shall include, at minimum, the following documentation pages: Installation, Usage (or Operation), Developer, Support.</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#best-practices-and-guidelines">Best Practices and Guidelines</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#installation-documentation">Installation Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#usage-documentation">Usage Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#developer-documentation">Developer Documentation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="seo.html">Search Engine Optimization</a></li>
</ul>
<p class="caption"><span class="caption-text">Teams</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../teams/teams.html">Teams</a></li>
</ul>
<p class="caption"><span class="caption-text">Support</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../support/help.html">Help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/forum.html">OpenPlanetary Forum</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html">Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html#request-a-new-tool-service">Request a New Tool / Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contribute.html#report-a-bug">Report a Bug</a></li>
<li class="toctree-l1"><a class="reference internal" href="../support/contact.html">Contact Us</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">NASA PDS Software</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li>PDS Software Documentation Best Practices</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/developer/pds_sw_docs.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="pds-software-documentation-best-practices">
<h1>PDS Software Documentation Best Practices<a class="headerlink" href="#pds-software-documentation-best-practices" title="Permalink to this headline">¶</a></h1>
<p>The following page will outline some best practices for PDS Software
Documentation.</p>
<hr class="docutils" />
<div class="section" id="purpose">
<h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this headline">¶</a></h2>
<p>To develop a set of best practices and guidelines for developing and
generating software documentation to ensure consistency across software
repositories.</p>
</div>
<hr class="docutils" />
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<div class="section" id="general-requirements">
<h3>General Requirements<a class="headerlink" href="#general-requirements" title="Permalink to this headline">¶</a></h3>
<div class="section" id="pds-shall-only-host-online-the-latest-version-of-software-documentation">
<h4>PDS shall only host online the latest version of software documentation.<a class="headerlink" href="#pds-shall-only-host-online-the-latest-version-of-software-documentation" title="Permalink to this headline">¶</a></h4>
<p>Ensures we don’t bump into changing versions breaking links or people
downloading the wrong version. Also eliminates the possibility that
Google will index and link to older versions of the docs / software.</p>
</div>
<div class="section" id="pds-shall-host-software-documentation-on-github-pages-for-all-open-source-repositories">
<h4>PDS shall host software documentation on Github Pages for all Open Source repositories<a class="headerlink" href="#pds-shall-host-software-documentation-on-github-pages-for-all-open-source-repositories" title="Permalink to this headline">¶</a></h4>
<p>We should use Github Pages as much as possible to minimize confusion. We
may even want to look at</p>
</div>
<div class="section" id="pds-shall-generate-a-documentation-package-with-each-release-and-upload-to-github-release-assets">
<h4>PDS shall generate a documentation package with each release and upload to Github Release Assets.<a class="headerlink" href="#pds-shall-generate-a-documentation-package-with-each-release-and-upload-to-github-release-assets" title="Permalink to this headline">¶</a></h4>
<p>This ensures we have links to past documentation that can be downloaded
and used, but this is not hosted online.</p>
</div>
<div class="section" id="pds-shall-generate-a-past-releases-page-for-each-software-tool-which-includes-links-to-the-source-code-download-package-and-documentation">
<h4>PDS shall generate a Past Releases page for each software tool, which includes links to the source code / download package and documentation.<a class="headerlink" href="#pds-shall-generate-a-past-releases-page-for-each-software-tool-which-includes-links-to-the-source-code-download-package-and-documentation" title="Permalink to this headline">¶</a></h4>
<p>For Python applications, this should link to source code download links.
For Java applications, should link to the download applications. For
other programming languages, default to linking to source code.</p>
</div>
</div>
<div class="section" id="pds-shall-include-at-minimum-the-following-documentation-pages-installation-usage-or-operation-developer-support">
<h3>PDS shall include, at minimum, the following documentation pages: Installation, Usage (or Operation), Developer, Support.<a class="headerlink" href="#pds-shall-include-at-minimum-the-following-documentation-pages-installation-usage-or-operation-developer-support" title="Permalink to this headline">¶</a></h3>
</div>
</div>
<hr class="docutils" />
<div class="section" id="best-practices-and-guidelines">
<h2>Best Practices and Guidelines<a class="headerlink" href="#best-practices-and-guidelines" title="Permalink to this headline">¶</a></h2>
<div class="section" id="installation-documentation">
<h3>Installation Documentation<a class="headerlink" href="#installation-documentation" title="Permalink to this headline">¶</a></h3>
<p>TBD template?</p>
</div>
<div class="section" id="usage-documentation">
<h3>Usage Documentation<a class="headerlink" href="#usage-documentation" title="Permalink to this headline">¶</a></h3>
<p>TBD template?</p>
</div>
<div class="section" id="developer-documentation">
<h3>Developer Documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h3>
<p>Should include, at minimum, the following information (should this just
link to the repo README?):</p>
<ul class="simple">
<li><p>Build from source instructions</p></li>
<li><p>Release instructions</p></li>
<li><p>Contribute information</p></li>
</ul>
</div>
</div>
<hr class="docutils" />
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h2>
<p>Should look something like the following:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Found a bug? Or want a new feature? We would love your feedback and contributions. Please submit new issues into our repository Github Issue Tracking:
Issue Tracking: https://github.com/NASA-PDS/pds-deep-archive/issues
If you require additional help or more immediate assistance, please email us at [email protected]
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="seo.html" class="btn btn-neutral float-right" title="Search Engine Optimization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="pds_ci_cd.html" class="btn btn-neutral float-left" title="PDS Continuous Integration / Continuous Deployment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020 California Institute of Technology
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>