doc/cephfs: edit front matter in client-auth.rst #57119
Conversation
doc/cephfs/client-auth.rst
Outdated
| @@ -2,15 +2,15 @@ | |||
| CephFS Client Capabilities | |||
| ================================ | |||
|
|
|||
| Use Ceph authentication capabilities to restrict your file system clients | |||
| to the lowest possible level of authority needed. | |||
| Ceph authentication capabilities are used to restrict file system clients to | |||
| .. note:: Path restriction and layout modification restriction are new features | ||
| in the Jewel release of Ceph. | ||
| .. note:: Path restriction and layout-modification restriction were introduced | ||
| in the Jewel release of Ceph. |
There was a problem hiding this comment.
Maybe we don’t care about Infernalis and earlier? Remove?
There was a problem hiding this comment.
I'm on the fence about removing stuff like this.
The case for removing information about when features were introduced: this is a technical manual, meant to explain how to use Ceph. This is not a historical record of the development of Ceph.
The case against removing information about when features were introduced: It's nice to know when features were introduced, and gives a sense of Ceph as an ongoing concern that responds to the world in which it serves the ends of its users and developers.
doc/cephfs/client-auth.rst
Outdated
| be enabled on the data pools. | ||
| .. note:: Using Erasure Coded (EC) pools with CephFS is supported only with | ||
| :term:`BlueStore`. Erasure-coded pools cannot be used as metadata pools and | ||
| overwrites must be enabled on the data pools. |
There was a problem hiding this comment.
I agree with this change, but I think that we should do even more--this sentence should be split into two sentences. The way that it is now suggests that "overwrites" is the second item in a list that begins with "metadata pools", when in fact "overwrites" is the beginning of a second proposition, unrelated to the first.
zdover23
force-pushed
the
wip-doc-2024-04-28-cephfs-client-auth
branch
from
83f8792
to
dc4fc8f
Compare
Clarify the front matter in doc/cephfs/client-auth.rst. Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com> Signed-off-by: Zac Dover <zac.dover@proton.me>
zdover23
force-pushed
the
wip-doc-2024-04-28-cephfs-client-auth
branch
from
dc4fc8f
to
713c730
Compare
Clarify the front matter in doc/cephfs/client-auth.rst.
Contribution Guidelines
To sign and title your commits, please refer to Submitting Patches to Ceph.
If you are submitting a fix for a stable branch (e.g. "quincy"), please refer to Submitting Patches to Ceph - Backports for the proper workflow.
When filling out the below checklist, you may click boxes directly in the GitHub web UI. When entering or editing the entire PR message in the GitHub web UI editor, you may also select a checklist item by adding an
xbetween the brackets:[x]. Spaces and capitalization matter when checking off items this way.Checklist
Show available Jenkins commands
jenkins retest this pleasejenkins test classic perfjenkins test crimson perfjenkins test signedjenkins test make checkjenkins test make check arm64jenkins test submodulesjenkins test dashboardjenkins test dashboard cephadmjenkins test apijenkins test docsjenkins render docsjenkins test ceph-volume alljenkins test ceph-volume toxjenkins test windowsjenkins test rook e2e