Good morning, Here are a few issues I noticed with the documentation: 1: Page : Hardware Recommendation ( https://docs.ceph.com/en/latest/start/hardware-recommendations/) Issue: Spelling on word "overprovsioning" 2: Page : Hardware Recommendation ( https://docs.ceph.com/en/latest/start/hardware-recommendations/) Issue: Missing word in sentence "You should also each host’s percentage of the cluster’s overall capacity." Potential fix: Add the word check between "also" and "each" 3: Page: https://docs.ceph.com/en/reef/cephfs/mount-prerequisites/ Issue: Broken Link: "You can use CephFS by mounting it to your local filesystem or by using [cephfs-shell]( https://docs.ceph.com/en/reef/cephfs/cephfs-shell)." 4: Page: https://docs.ceph.com/en/reef/rados/configuration/mon-lookup-dns/#looking-up... Issue: lacking information: As you can see in the code here: https://github.com/ceph/ceph/blob/cac7dcd63481ddbc4fe26f4b8d5918510e8be457/s... in lines 790-793 and through experimentation you can use the "mon_dns_srv_name" directive to pass either the "ceph-mon" and use DNS search domains, as mentioned on this page or you can pass the name followed by an underscore to manually pass the search domain. For example: ceph-mon_example.com with records placed in _ceph-mon._example.com Have a lovely day
Thank you for this, Lander. I will reply to each of these issues in separate emails, for the sake of keeping my response maximally legible.
1: Page : Hardware Recommendation ( https://docs.ceph.com/en/latest/start/hardware-recommendations/) Issue: Spelling on word "overprovsioning"
Thank you for this. The word "overprovisioning" has been corrected in this PR: https://github.com/ceph/ceph/pull/58363 Zac Dover Head of Documentation Ceph Foundation
Lander, Here is the resolution of the second of your reported documentation bugs:
2: Page : Hardware Recommendation ( https://docs.ceph.com/en/latest/start/hardware-recommendations/) Issue: Missing word in sentence "You should also each host’s percentage of the cluster’s overall capacity." Potential fix: Add the word check between "also" and "each"
This error presented because https://github.com/ceph/ceph/pull/55577 had not been backported. I have raised backport PRs to transmit this change into the Reef and Quincy branches. The text is already correct in the Squid branch--I haven't gotten to the bottom of why the change made it into Squid, but it will be a trivial matter to discover the cause and I will get to that when circumstances permit. Anyway, here are the backport PRs that transmit this correction into the Reef and Quincy branches: https://github.com/ceph/ceph/pull/58364 - Reef backport https://github.com/ceph/ceph/pull/58364 - Quincy backport Thank you for your attention to the documentation. Zac Dover Head of Documentation Ceph Foundation
Lander, Here is the resolution of the third of your reported documentation bugs:
3: Page: https://docs.ceph.com/en/reef/cephfs/mount-prerequisites/ Issue: Broken Link: "You can use CephFS by mounting it to your local filesystem or by using cephfs-shell."
https://github.com/ceph/ceph/pull/58366 This link was broken because a file was moved thirty-eight months ago (https://github.com/ceph/ceph/pull/41165/) and the links associated with it were not updated at that time. Thank you for finding this broken link. Zac Dover Head of Documentation Ceph Foundation
Lander, Here is the resolution of the fourth of your reported documentation bugs:
4: Page: https://docs.ceph.com/en/reef/rados/configuration/mon-lookup-dns/#looking-up... Issue: lacking information: As you can see in the code here: https://github.com/ceph/ceph/blob/cac7dcd63481ddbc4fe26f4b8d5918510e8be457/s... in lines 790-793 and through experimentation you can use the "mon_dns_srv_name" directive to pass either the "ceph-mon" and use DNS search domains, as mentioned on this page or you can pass the name followed by an underscore to manually pass the search domain. For example: ceph-mon_example.com with records placed in _ceph-mon._example.com
https://github.com/ceph/ceph/pull/58368 Zac Dover Head of Documentation Ceph Foundation
participants (2)
-
Lander Duncan
-
Zac Dover