update sources to v12.1.2

[ceph.git] / ceph / doc / dev / documenting.rst

diff --git a/ceph/doc/dev/documenting.rst b/ceph/doc/dev/documenting.rst
index 602f3c769c4549a4203be1523727172d998a07ed..63e1f191f7bb758c3aa59030c8ca9a005c4430aa 100644 (file)
--- a/ceph/doc/dev/documenting.rst
+++ b/ceph/doc/dev/documenting.rst
@@ -2,6 +2,28 @@
  Documenting Ceph
 ==================
 
+User documentation
+==================
+
+The documentation on docs.ceph.com is generated from the restructuredText
+sources in ``/doc/`` in the Ceph git repository.
+
+Please make sure that your changes are written in a way that is intended
+for end users of the software, unless you are making additions in
+``/doc/dev/``, which is the section for developers.
+
+All pull requests that modify user-facing functionality must
+include corresponding updates to documentation: see 
+`Submitting Patches`_ for more detail.
+
+Check your .rst syntax is working as expected by using the "View"
+button in the github user interface when looking at a diff on
+an .rst file, or build the docs locally using the ``admin/build-doc``
+script.
+
+For more information about the Ceph documentation, see 
+:doc:`/start/documenting-ceph`.
+
 Code Documentation
 ==================
 
@@ -48,7 +70,7 @@ You can use Graphviz_, as explained in the `Graphviz extension documentation`_.
    digraph "example" {
      foo -> bar;
      bar -> baz;
-     bar -> thud;
+     bar -> th
    }
 
 Most of the time, you'll want to put the actual DOT source in a
@@ -106,3 +128,5 @@ By committing the SVG file, others will be able to update the
 SVG diagrams using Inkscape.
 
 HTML5 will support SVG inline.
+
+.. _Submitting Patches: /SubmittingPatches.rst