New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add doc requirements on PR submitters #16394

Merged
merged 1 commit into from Jul 25, 2017

Conversation

@jcsp
Contributor

jcsp commented Jul 18, 2017

Signed-off-by: John Spray john.spray@redhat.com

@jcsp jcsp requested review from liewegas, batrick, jdurgin, yehudasa and dillaman Jul 18, 2017

as CLI commands or their output, then the patch series or pull request
must include appropriate updates to documentation.
It is the submitters responsibility to make the changes, and the reviewer's

This comment has been minimized.

@theanalyst

theanalyst Jul 18, 2017

Member

submitter's?

All pull requests that modify user-facing functionality must
include corresponding updates to documentation: see
`Submitting Patches`_ for more detail.

This comment has been minimized.

@theanalyst

theanalyst Jul 18, 2017

Member

Since this is meant for general consumption, why not move it under start/documenting-ceph ?

This comment has been minimized.

@jcsp

jcsp Jul 19, 2017

Contributor

I think we want this here in the procedures for developers so that code contributors see it, not just people seeking out info about documentation. However, I'll add a hyperlink here to the start/documenting-ceph page, so that we're not tempted to duplicate too much stuff.

==================
The documentation on docs.ceph.com is generated from the restructuredText
sources in ``/doc/`` in the Ceph git repository.

This comment has been minimized.

@batrick

batrick Jul 18, 2017

Member

Speaking of this, is there an easy way to see a preview of the rendered doc? If so, we should include that here.

This comment has been minimized.

@theanalyst

theanalyst Jul 18, 2017

Member

there is admin/build-doc and admin/serve-doc scripts

This comment has been minimized.

@vasukulkarni

vasukulkarni Jul 18, 2017

Member

github view should now render the rst doc properly? there is also restview that one can install on local host: https://pypi.python.org/pypi/restview

This comment has been minimized.

@liewegas

liewegas Jul 18, 2017

Member

this would be a good place to mention how to run admin/build-doc

This comment has been minimized.

@ktdreyer

ktdreyer Jul 18, 2017

Member

There's also the "View" button in GitHub's UI

For https://github.com/ceph/ceph branches, we also auto-generate docs for every branch, eg. http://docs.ceph.com/docs/master/architecture/ <- substitute master with your wip- branch's name. But you have to push to the main ceph.git, not ceph-ci.git or your own fork.

This comment has been minimized.

@jcsp

jcsp Jul 20, 2017

Contributor

I've added a para mentioning admin/build-doc and github's "View" (which was new to me!)

@gregsfortytwo

LGTM

John Spray
doc: add doc requirements on PR submitters
Signed-off-by: John Spray <john.spray@redhat.com>

@tchaikov tchaikov merged commit be7d9d9 into ceph:master Jul 25, 2017

3 of 4 checks passed

make check (arm64) make check failed
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check make check succeeded
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment