Skip to content

Commit

Permalink
update help to include very short howto. version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
rinigus committed Jul 8, 2016
1 parent 0811879 commit 5dd49a8
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 3 deletions.
35 changes: 34 additions & 1 deletion qml/HelpText.qml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@ configuration on this level.</p>" ) + "
On Desktop, press Esc or the right mouse button to get out of this HOWTO.
On Sailfish, swipe the page back, as usual.</p>
<h2>Very short version</h2>
<p>For those who are just checking out and/or are trusting the default settings:</p>
<ol>
<li>Go to Settings, select <i>Use " + programName + " to enable/disable collectd</i>.</li>
<li>In Settings, select <i>Run collectd</i> and, if you wish, <i>Enable collectd on boot</i>.
Note that when you select Run, GUI may revert back Help screen or graph list.</li>
<li>Close GUI and wait for 10 minutes. You can close it after 10 minutes, but GUI restart is needed.</li>
<li>Start the GUI and check if a directory corresponding to running collectd passed a check in Status.</li>
<li>Go to Settings, scroll down, and push the button to <i>Generate definitions</i>.</li>
</ol>
<p>If it all worked, you are all set and can proceed monitoring your system. To see the generated outline of graphs
and other info regarding GUI, go to Status (Sailfish only at present). In Status, you could also copy the state to
clipboard via pulley menu. If you wish to know more, something failed, or you want to
tune it, read on. </p>
<p>Below, is more detailed HOWTO</p>
<h2>Start <i>collectd</i></h2>
<p>If you have not started <i>collectd</i>, then you have to start it. This GUI supports systemd and you could use it for starting/stopping and
Expand Down Expand Up @@ -78,6 +98,11 @@ and should be filled (at least the running one) if collectd
runs. The second directory (on collectd stopped) would get filled
when collectd has been stopped earlier. </p>
<p>After setting directory(ies), go to Status to see if the directory(ies)
are passing the check. If you just started, you are mainly interested in the
directory that corresponds to current <i>collectd</i> state (running or stopped).</p>
<h3>Configuration loading by GUI</h3>
<p>Note that when configuration is changed by loading a new one in
Expand All @@ -89,7 +114,15 @@ file is unavailable, the corresponding graph will not be
shown. If the file appeared later, you would have to reload
configuration to get it detected.</p>
<h3>Make configuration using a helper script</h3>
<p>At any stage, you could check the configuration under Status.</p>
<h3>Make configuration from GUI</h3>
<p>Go to Settings and press the button Generate configuration. The configuration
script will be run by GUI and configuration loaded from it. If it works, you are all
set.</p>
<h3>Make configuration using a helper script and command line</h3>
<p>The helper script requires python2.7, which should be installed as dependency in Sailfish .</p>
Expand Down
2 changes: 1 addition & 1 deletion rpm/systemdatascope.spec
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name: systemdatascope
%{!?qtc_make:%define qtc_make make}
%{?qtc_builddir:%define _builddir %qtc_builddir}
Summary: System Data Scope
Version: 0.1.2
Version: 0.2.0
Release: 1
Group: Qt/Qt
License: MIT
Expand Down
2 changes: 1 addition & 1 deletion rpm/systemdatascope.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Name: systemdatascope
Summary: System Data Scope
Version: 0.1.2
Version: 0.2.0
Release: 1
# The contents of the Group field should be one of the groups listed here:
# http://gitorious.org/meego-developer-tools/spectacle/blobs/master/data/GROUPS
Expand Down
4 changes: 4 additions & 0 deletions translations/systemdatascope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,10 @@
<source>Generate definitions</source>
<translation type="unfinished"></translation>
</message>
<message>
<source>Generate graph definitions using systemdatascope-makeconfig:</source>
<translation type="unfinished"></translation>
</message>
</context>
<context>
<name>StatusPL</name>
Expand Down

0 comments on commit 5dd49a8

Please sign in to comment.