RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-14 06:53:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/start/documenting-ceph.rst: make better doc recommendations

Browse Source 
I do not think "Editors" is relevant anymore.

Signed-off-by: Neha Ojha <nojha@redhat.com>
This commit is contained in:
Neha Ojha 2019-09-09 15:12:37 -07:00
parent c52b8b0c76
commit 07aef79693
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/start/documenting-ceph.rst
View 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. ::