-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path41_contributing.html
456 lines (309 loc) · 18 KB
/
41_contributing.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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Contributing — RPi-Monitor v2.13-r0</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="next" title="Authors and Licenses" href="42_license.html" />
<link rel="prev" title="To go further" href="40_index.html" />
<script src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<script>
(adsbygoogle = window.adsbygoogle || []).push({
google_ad_client: "ca-pub-6853682829194266",
enable_page_level_ads: true
});
</script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-114314379-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-18642541-8');
</script>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<img style="position: fixed; top: 0; right: 0; z-index: 100; height:300px; border: 0;" src="_images/wip.png">
<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"> RPi-Monitor
</a>
<div class="version">
2.13
</div>
<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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="01_features.html">Keys features of RPi-Monitor</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="10_index.html">Getting started</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="20_index.html">Configuration</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="30_index.html">Usages</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="40_index.html">To go further</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="42_license.html">Authors and Licenses</a></li>
<li class="toctree-l2"><a class="reference internal" href="43_changelog.html">Release note</a></li>
</ul>
</li>
</ul>
<hr />
<div style="padding: 0;">
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<ins class="adsbygoogle"
style="display:inline-block;width:300px;height:250px"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
</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">RPi-Monitor</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">Docs</a> »</li>
<li><a href="40_index.html">To go further</a> »</li>
<li>Contributing</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/XavierBerger/RPi-Monitor/blob/develop/docs/source/41_contributing.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>If you want to contribute to <strong>RPi-Monitor</strong> and propose a pull request, first
create a fork from <a class="reference external" href="https://github.com/XavierBerger/RPi-Monitor">github</a></p>
<div class="section" id="contribute-to-documentation">
<h2>Contribute to documentation<a class="headerlink" href="#contribute-to-documentation" title="Permalink to this headline">¶</a></h2>
<p><strong>RPi-Monitor</strong> documentation is written in reStructured Text using
<a class="reference external" href="http://www.sphinx-doc.org/en/master/">sphinx</a> document generator and
<a class="reference external" href="https://sphinx-rtd-theme.readthedocs.io/en/latest/index.html">Read the docs theme</a>
(included in project as <cite>git submodule</cite>)</p>
<div class="section" id="prepare-development-environment">
<h3>Prepare development environment<a class="headerlink" href="#prepare-development-environment" title="Permalink to this headline">¶</a></h3>
<p>Clone your fork and update theme with the following commands:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>git clone git@github.com:${GITHUB_ACCOUNT}/RPi-Monitor.git
cd RPi-Monitor
git submodule update --init --recursive
pip install sphinx sphinx-autobuild
</pre></div>
</div>
</div>
<div class="section" id="generate-documentation">
<h3>Generate documentation<a class="headerlink" href="#generate-documentation" title="Permalink to this headline">¶</a></h3>
<p>The following command update the documentation and start firefox on generated documentation:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">docs</span>
<span class="n">make</span> <span class="n">clean</span> <span class="o">&&</span> <span class="n">make</span> <span class="n">html</span> <span class="o">&&</span> <span class="n">firefox</span> <span class="n">build</span><span class="o">/</span><span class="n">html</span><span class="o">/</span><span class="n">index</span><span class="o">.</span><span class="n">html</span>
</pre></div>
</div>
</div>
<div class="section" id="propose-a-merge-request">
<h3>Propose a merge request<a class="headerlink" href="#propose-a-merge-request" title="Permalink to this headline">¶</a></h3>
<p>Once your modifications are done, you can propose a pull request on github.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">Propose pull requests on <strong>develop</strong> branch only.</p>
</div>
</div>
</div>
<div class="section" id="contribute-to-software">
<h2>Contribute to software<a class="headerlink" href="#contribute-to-software" title="Permalink to this headline">¶</a></h2>
<div class="section" id="report-issue">
<h3>Report issue<a class="headerlink" href="#report-issue" title="Permalink to this headline">¶</a></h3>
<p>Whether you’ve found an issue with <strong>RPI-Monitor</strong>, here’s how to report the problem...</p>
<p>First, check the documentation for solutions to common problems.</p>
<div class="section" id="to-file-a-bug">
<h4>To file a bug<a class="headerlink" href="#to-file-a-bug" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><ul class="simple">
<li>Go to <a class="reference external" href="https://github.com/XavierBerger/RPi-Monitor/issues">issue tracker on GitHub</a></li>
<li>Search for existing issues using the search field at the top of the page</li>
<li>File a new issue with all details explaining how to reproduce the bug</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="requesting-a-feature">
<h4>Requesting a feature<a class="headerlink" href="#requesting-a-feature" title="Permalink to this headline">¶</a></h4>
<p>Feel free to file new feature requests as an <a class="reference external" href="https://github.com/XavierBerger/RPi-Monitor/issues">issue on GitHub</a>, just like a bug.</p>
</div>
</div>
<div class="section" id="id1">
<h3>Propose a merge request<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>GitHub is used to perform versioning of development and also to store the
development progress of future releases.</p>
<p>The branch master contains the latest stable version.</p>
<p>The branch <code class="docutils literal"><span class="pre">develop</span></code> is the unstable development branch (The branch may have bugs
and partially released code that could avoid RPi-Monitor to run as expected).</p>
<p>Each release is identified by a tag.</p>
<p>You want to contribute to <strong>RPi-Monitor</strong>. I’ll be happy to integrate your pull request.</p>
<p>Please note: Pull request perfomed on <code class="docutils literal"><span class="pre">develop</span></code> branch will be integrated as soon
as possible. Pull request perform on master branche may only be integrated
when a new version is published (or not may not be integrated at all...)</p>
</div>
</div>
<div class="section" id="packaging">
<h2>Packaging<a class="headerlink" href="#packaging" title="Permalink to this headline">¶</a></h2>
<p>This document describe how <strong>RPi-Monitor</strong> is packaged and installed.</p>
<div class="section" id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
<p><strong>rpimonitord</strong> is a perl script which require the following perl modules to work:</p>
<blockquote>
<div><ul class="simple">
<li>perl</li>
<li>librrds-perl</li>
<li>libhttp-daemon-perl (>= 6.0.0) | libwww-perl (<< 6.0.0)</li>
<li>libjson-perl</li>
<li>libipc-sharelite-perl</li>
<li>libfile-which-perl</li>
<li>libsnmp-extension-passpersist-perl</li>
<li>aptitude (required by script checking upgradable packages)</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="programs">
<h3>Programs<a class="headerlink" href="#programs" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/usr/bin/rpimonitord</span></code> : <em>Daemon extracting data from the system and embedding the web application server - The help page is used to generate manpage</em></li>
<li><code class="docutils literal"><span class="pre">/etc/cron.d/rpimonitor</span></code> : <em>daily extraction the status of package update updating the file</em> <code class="docutils literal"><span class="pre">updatestatus.txt</span></code></li>
<li><code class="docutils literal"><span class="pre">/etc/init.d/rpimonitor</span></code> : <em>sysVinit startup script</em></li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><strong>upstart</strong> and <strong>systemd</strong> script are also avialable in the repository</p>
</div>
</div>
<div class="section" id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/etc/rpimonitor/daemon.conf</span></code> : <em>configuration of rpimonitord daemon</em></li>
<li><code class="docutils literal"><span class="pre">/etc/rpimonitor/data.conf</span></code> : <em>symlink to</em> <code class="docutils literal"><span class="pre">template/<distribution>.conf</span></code> <em>configuration of default data to be extracted and presented</em></li>
<li><code class="docutils literal"><span class="pre">/etc/rpimonitor/*.conf</span></code> : <em>all other</em> <code class="docutils literal"><span class="pre">*.conf</span></code> <em>file will be parsed to look for data to be monitored</em></li>
<li><code class="docutils literal"><span class="pre">/etc/rpimonitor/template/*.conf</span></code> : <em>data configuration template customized for different distribution and additionnal examples</em></li>
</ul>
<p>Some configuration files are provided for different distribution (raspbian, xbian, ...).
These files are stored into the subdirectory <code class="docutils literal"><span class="pre">/etc/rpimonitor/templates/</span></code>.
For supported distribution, the post installation script of package creates a link, <code class="docutils literal"><span class="pre">data.conf</span></code>, pointing to the configuration files dedicated to the distribution.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The template directory is also containing some templates that can be used as example to customize configuration.</p>
</div>
</div>
<div class="section" id="manpages">
<h3>Manpages<a class="headerlink" href="#manpages" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/usr/share/man/man5/rpimonitord.conf.5.gz</span></code> : <em>Manpage for rpimonitor and data extraction configuration</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/man/man1/rpimonitord.1.gz</span></code> : <em>Manpage for rpimonitord command line usage</em></li>
</ul>
</div>
<div class="section" id="web-interface">
<h3>Web Interface<a class="headerlink" href="#web-interface" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web</span></code> : <em>Directory containing html</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/js</span></code> : <em>Directory containing javascripts</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/css</span></code> : <em>Directory containing style</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/img</span></code> : <em>Directory containing images</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/fonts</span></code> : <em>Directory containing fonts</em></li>
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web/addons</span></code> : <em>Directory containing addons</em></li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">When <strong>RPi-Monitor</strong> is configured to not use the internal server, the json are written on the disk into the web root directory <code class="docutils literal"><span class="pre">/usr/share/rpimonitor/web</span></code></p>
</div>
</div>
<div class="section" id="scripts">
<h3>Scripts<a class="headerlink" href="#scripts" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/usr/share/rpimonitor/scripts/updatePackagesStatus.pl</span></code> : <em>Script periodically executed to update</em> <code class="docutils literal"><span class="pre">/var/lib/rpimonitor/updatestatus.txt</span></code></li>
</ul>
</div>
<div class="section" id="data">
<h3>Data<a class="headerlink" href="#data" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">/var/lib/rpimonitor/web/stat</span></code> : <em>Directory containing</em> <code class="docutils literal"><span class="pre">*.rrd</span></code></li>
<li><code class="docutils literal"><span class="pre">/var/lib/rpimonitor/updatestatus.txt</span></code> : <em>Current status of packages update</em></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="42_license.html" class="btn btn-neutral float-right" title="Authors and Licenses" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="40_index.html" class="btn btn-neutral" title="To go further" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Xavier Berger.
Last updated on Mar 18, 2018.
</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>.
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enableSticky();
});
</script>
</body>
</html>