Skip to content

Commit dd66c9e

Browse files
committed
doc/start: edit documenting-ceph.rst
Edit the section "Build the Source" in doc/start/documenting-ceph.rst. Also correct a misuse of the word "presently", which means "in a little while", not "now". Signed-off-by: Zac Dover <[email protected]>
1 parent bb1109a commit dd66c9e

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/start/documenting-ceph.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -253,31 +253,31 @@ To scan for the reachability of external links, execute:
253253

254254
admin/build-doc linkcheck
255255

256-
Executing ``admin/build-doc`` will create a ``build-doc`` directory under
256+
Running ``admin/build-doc`` creates a ``build-doc`` directory under
257257
``ceph``. You may need to create a directory under ``ceph/build-doc`` for
258-
output of Javadoc files:
258+
Javadoc file output:
259259

260260
.. prompt:: bash $
261261

262262
mkdir -p output/html/api/libcephfs-java/javadoc
263263

264-
The build script ``build-doc`` will produce an output of errors and warnings.
265-
You MUST fix errors in documents you modified before committing a change, and
266-
you SHOULD fix warnings that are related to syntax you modified.
264+
The build script ``build-doc`` produces output partially consisting of errors
265+
and warnings. You MUST fix errors in documents you modified before committing
266+
a change, and you SHOULD fix warnings that are related to syntax you modified.
267267

268268
.. important:: You must validate ALL HYPERLINKS. If a hyperlink is broken,
269269
it automatically breaks the build!
270270

271-
Once you build the documentation set, you may start an HTTP server at
272-
``http://localhost:8080/`` to view it:
271+
After you have built the documentation set, you may start an HTTP server at
272+
``http://localhost:8080/`` to view it by running the following command:
273273

274274
.. prompt:: bash $
275275

276276
admin/serve-doc
277277

278278
You can also navigate to ``build-doc/output`` to inspect the built documents.
279-
There should be an ``html`` directory and a ``man`` directory containing
280-
documentation in HTML and manpage formats respectively.
279+
Within ``build-doc/output`` is an ``html`` directory and a ``man`` directory
280+
containing documentation in HTML and manpage formats respectively.
281281

282282
Build the Source (First Time)
283283
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -397,8 +397,8 @@ the packages. Then, download them from a mirror and install them. For example:
397397
wget http://rpmfind.net/linux/centos/7/os/x86_64/Packages/python-sphinx-1.1.3-11.el7.noarch.rpm
398398
sudo yum install python-sphinx-1.1.3-11.el7.noarch.rpm
399399

400-
Ceph documentation makes extensive use of `ditaa`_, which is not presently built
401-
for CentOS/RHEL7. You must install ``ditaa`` if you are making changes to
400+
Ceph documentation makes extensive use of `ditaa`_, which is not currently
401+
built for CentOS/RHEL7. You must install ``ditaa`` if you are making changes to
402402
``ditaa`` diagrams so that you can verify that they render properly before you
403403
commit new or modified ``ditaa`` diagrams. You may retrieve compatible required
404404
packages for CentOS/RHEL distributions and install them manually. To run

0 commit comments

Comments
 (0)