Per minor-version view on docs.ceph.com
Hi, I have a request about docs.ceph.com. Could you provide per minor-version views on docs.ceph.com? Currently, we can select the Ceph version by using `https://docs.ceph.com/en/<version>". In this case, we can use the major version's code names (e.g., "quincy") or "latest". However, we can't use minor version numbers like "v17.2.6". It's convenient for me (and I guess for many other users, too) to be able to select the document for the version which we actually use. In my recent case, I've read the mclock's document of quincy because I use v17.2.6. However, the document has changed a lot from v17.2.6 to the quincy's latest one because of the recent mclock's rework. Thanks, Satoru
The docs aren't necessarily structured that way, i.e. there isn't a 17.2.6 docs site as such. We try to document changes in behavior in sync with code, but don't currently have a process to ensure that a given docs build corresponds exactly to a given dot release. In fact we sometimes go back and correct things for earlier releases. For your purposes I might suggest: * Peruse the minor-version release notes for docs PRs * Pull the release tree for a minor version from git and peruse the .rst files directly Neither is what you're asking for, but it's what we have today. Zac might have additional thoughts.
On Jul 11, 2023, at 23:44, Satoru Takeuchi <satoru.takeuchi@gmail.com> wrote:
Hi,
I have a request about docs.ceph.com. Could you provide per minor-version views on docs.ceph.com? Currently, we can select the Ceph version by using `https://docs.ceph.com/en/<version>". In this case, we can use the major version's code names (e.g., "quincy") or "latest". However, we can't use minor version numbers like "v17.2.6". It's convenient for me (and I guess for many other users, too) to be able to select the document for the version which we actually use.
In my recent case, I've read the mclock's document of quincy because I use v17.2.6. However, the document has changed a lot from v17.2.6 to the quincy's latest one because of the recent mclock's rework.
Thanks, Satoru _______________________________________________ ceph-users mailing list -- ceph-users@ceph.io To unsubscribe send an email to ceph-users-leave@ceph.io
Hi Anthony,
The docs aren't necessarily structured that way, i.e. there isn't a 17.2.6 docs site as such. We try to document changes in behavior in sync with code, but don't currently have a process to ensure that a given docs build corresponds exactly to a given dot release. In fact we sometimes go back and correct things for earlier releases.
I see.
For your purposes I might suggest:
* Peruse the minor-version release notes for docs PRs * Pull the release tree for a minor version from git and peruse the .rst files directly
Thank you for suggestion.
Neither is what you're asking for, but it's what we have today. Zac might have additional thoughts.
Zac, do you have any thought? Best, Satoru
Hi, On 7/12/23 05:44, Satoru Takeuchi wrote:
I have a request about docs.ceph.com. Could you provide per minor-version views on docs.ceph.com?
I would like to second that. Sometimes the behaviour of Ceph changes a lot between point releases. If the documentation gets unreliable it does not shine a good light on the project. Regards -- Robert Sander Heinlein Consulting GmbH Schwedter Str. 8/9b, 10119 Berlin https://www.heinlein-support.de Tel: 030 / 405051-43 Fax: 030 / 405051-19 Amtsgericht Berlin-Charlottenburg - HRB 220009 B Geschäftsführer: Peer Heinlein - Sitz: Berlin
participants (3)
-
Anthony D'Atri
-
Robert Sander
-
Satoru Takeuchi