]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/start/documenting-ceph.rst: make better doc recommendations
authorNeha Ojha <nojha@redhat.com>
Mon, 9 Sep 2019 22:12:37 +0000 (15:12 -0700)
committerNeha Ojha <nojha@redhat.com>
Mon, 9 Sep 2019 22:40:45 +0000 (15:40 -0700)
I do not think "Editors" is relevant anymore.

Signed-off-by: Neha Ojha <nojha@redhat.com>
doc/start/documenting-ceph.rst

index b83c2288969aca142b0e87103498d209127ce360..937ad677bda7b375e222fd82471edb7e47c0df61 100644 (file)
@@ -132,10 +132,11 @@ should be ``wip-doc-4000`` by convention and the relevant tracker URL will be
 http://tracker.ceph.com/issues/4000.
 
 .. note:: Please do not mingle documentation contributions and source code
-   contributions in a single pull request. Editors review the documentation
-   and engineers review source code changes. When you keep documentation 
-   pull requests separate from source code pull requests, it simplifies the 
-   process and we won't have to ask you to resubmit the requests separately.
+   contributions in a single commit. When you keep documentation
+   commits separate from source code commits, it simplifies the review
+   process. We highly recommend that any pull request that adds a feature or
+   a configuration option, should also include a documentation commit,
+   describing the relevant changes/options.
 
 Before you create your branch name, ensure that it doesn't already exist in the
 local or remote repository. ::