Skip to content

Commit 87a375c

Browse files
committed
doc/mgr: edit hello.rst
Edit doc/mgr/hello.rst. This includes the rewriting of sentences so that they now appear in grammatically-correct English. This is part of a project to separate out the twenty-five files that were committed to ceph#62782. Signed-off-by: Zac Dover <[email protected]>
1 parent 1d1b0db commit 87a375c

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

doc/mgr/hello.rst

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,47 @@ This is a simple module skeleton for documentation purposes.
66
Enabling
77
--------
88

9-
The *hello* module is enabled with::
9+
Run the following command to enable the ``hello`` module:
1010

11-
ceph mgr module enable hello
11+
.. prompt:: bash #
1212

13-
To check that it is enabled, run::
13+
ceph mgr module enable hello
1414

15-
ceph mgr module ls
15+
Run the following command to ensure that the ``hello`` module is enabled:
1616

17-
After editing the module file (found in ``src/pybind/mgr/hello/module.py``), you can see changes by running::
17+
.. prompt:: bash #
1818

19-
ceph mgr module disable hello
20-
ceph mgr module enable hello
19+
ceph mgr module ls
2120

22-
or::
21+
After editing the module file (found in ``src/pybind/mgr/hello/module.py``),
22+
reload the module in order to pick up the changes by running the following
23+
commands:
2324

24-
init-ceph restart mgr
25+
.. prompt:: bash #
2526

26-
To execute the module, run::
27+
ceph mgr module disable hello
28+
ceph mgr module enable hello
2729

28-
ceph hello
30+
Alternatively, run the following command to reload the ``hello`` module and pick up changes to its settings:
2931

30-
The log is found at::
32+
.. prompt:: bash #
3133

32-
build/out/mgr.x.log
34+
init-ceph restart mgr
35+
36+
Run the following command to run the module:
37+
38+
.. prompt:: bash #
39+
40+
ceph hello
41+
42+
The log is found in the following file::
43+
44+
build/out/mgr.x.log
3345

3446

3547
Documenting
3648
-----------
3749

38-
After adding a new mgr module, be sure to add its documentation to ``doc/mgr/module_name.rst``.
39-
Also, add a link to your new module into ``doc/mgr/index.rst``.
50+
After adding a new mgr module, be sure to add its documentation to
51+
``doc/mgr/module_name.rst``. Also, add a link to your new module into
52+
``doc/mgr/index.rst``.

0 commit comments

Comments
 (0)