Skip to content
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: broken link on troubleshooting-mon page #25312

Merged
merged 1 commit into from Dec 8, 2018

Conversation

falcon78921
Copy link
Contributor

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug

Fixes: https://tracker.ceph.com/issues/37451

This fix involves adding :ref: labels to the add-or-rm-mons.rst
page. I also added :ref: labels for other headings within
add-or-rm-mons.rst (for future reference).

Signed-off-by: James McClune jmcclune@mcclunetechnologies.net

@falcon78921
Copy link
Contributor Author

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/25312/

Copy link
Member

@joscollin joscollin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. But I see that the other places in the documentation conventionally maintain the ref labels with a hyphen.

For example:
rados/configuration/mon-config-ref.rst: :ref:CRUSH map tunables for

Could you please fix that?

@falcon78921
Copy link
Contributor Author

@joscollin I noticed that. In past PR's, I followed suit with hyphenating :ref: labels.

Like here: https://github.com/ceph/ceph/pull/24785/files#diff-017fae76d50fa0791f035bf95f5a274dR513

The reason for putting the full title is simplicity. I noticed that many reference links in the Ceph documentation are broken. IMO, putting the whole title would better organize sections for reference, instead of having to lookup the :ref: label in raw format. Most section titles/commands are unique, so this could work. I would be more than happy to start converting all sections/subsections of documentation so they have :ref: labels. Just a recommendation...

If you still want me to fix, please let me know.

@joscollin
Copy link
Member

@falcon78921 Send an email to ceph-devel about your recommendation.

@falcon78921
Copy link
Contributor Author

falcon78921 commented Dec 8, 2018

@joscollin I squashed the commits into ca05e45. The corrections have been made.

Fixes: https://tracker.ceph.com/issues/37451

This fix involves adding :ref: labels to the add-or-rm-mons.rst
page. I also added :ref: labels for other headings within
add-or-rm-mons.rst (for future reference).

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
@joscollin joscollin merged commit 6672ffe into ceph:master Dec 8, 2018
@falcon78921 falcon78921 deleted the wip-doc-37451 branch December 13, 2018 02:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants