]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: add instructions about using "serve-doc" to preview built document 24471/head
authorKefu Chai <kchai@redhat.com>
Mon, 8 Oct 2018 10:10:46 +0000 (18:10 +0800)
committerKefu Chai <kchai@redhat.com>
Mon, 8 Oct 2018 10:11:01 +0000 (18:11 +0800)
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/start/documenting-ceph.rst

index 56cd8a3eecb3c432ff3fcb855109e003ce2dde30..b83c2288969aca142b0e87103498d209127ce360 100644 (file)
@@ -205,11 +205,12 @@ SHOULD fix warnings that are related to syntax you modified.
 .. important:: You must validate ALL HYPERLINKS. If a hyperlink is broken,
    it automatically breaks the build!
 
-Once you build the documentation set, you may navigate to the source directory
-to view it::
+Once you build the documentation set, you may start an HTTP server at
+``http://localhost:8080/`` to view it::
 
-       cd build-doc/output
+       admin/serve-doc
 
+You can also navigate to ``build-doc/output`` to inspect the built documents.
 There should be an ``html`` directory and a ``man`` directory containing
 documentation in HTML and manpage formats respectively.