From: Neha Ojha Date: Mon, 9 Sep 2019 22:12:37 +0000 (-0700) Subject: doc/start/documenting-ceph.rst: make better doc recommendations X-Git-Tag: v15.1.0~1628^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=07aef796932a156a6617f5417628a5a1b3dd9328;p=ceph-ci.git doc/start/documenting-ceph.rst: make better doc recommendations I do not think "Editors" is relevant anymore. Signed-off-by: Neha Ojha --- diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index b83c2288969..937ad677bda 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -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. ::