On 4/21/21 9:57 AM, Loïc Dachary wrote:
to make sure a given option/command exists in the stable release. Another
convenient way to see version specific changes is to embed them in the documentation itself. For instance
https://docs.python.org/3.9/library/asyncio-task.html#sleeping
"Deprecated since version 3.8, will be removed in version 3.10: The loop parameter."
But it's a *lot* more work and sometime confusing and ends up cluttering the documentation.
Yes, this is a bit orthogonal to me, since it applies more to particular
technical changes rather than changes like improving the wording or
filling in some missing docs.
We do have the version-added directive in sphinx to help with this sort
of indicator, but it is harder to maintain - I just removed some
referencing cuttlefish last week!
Josh
Cheers
On 21/04/2021 16:41, Josh Durgin wrote:
Hey folks, now that Pacific is out I wanted to bring up docs backports.
Today, docs.ceph.com shows master by default, with an appropriate
warning at the top that it represents a development version.
Since the primary audience of the docs is users, not developers, I
suggest that we switch the default branch to the latest stable, i.e.
pacific, and apply the normal backport process to docs that are
relevant to the latest stable release as well.
To kickstart things, I'll prepare a backport of the existing
doc changes since the pacific release.
What do folks think?
Josh
_______________________________________________
Dev mailing list -- dev@xxxxxxx
To unsubscribe send an email to dev-leave@xxxxxxx
_______________________________________________
Dev mailing list -- dev@xxxxxxx
To unsubscribe send an email to dev-leave@xxxxxxx
