Re: docs backports

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Josh,

This is an excellent idea :+1:. I often switch:

https://docs.ceph.com/en/latest/man/8/rbd/

to

https://docs.ceph.com/en/octopus/man/8/rbd/

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.

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

-- 
Loïc Dachary, Artisan Logiciel Libre


Attachment: OpenPGP_signature
Description: OpenPGP digital signature

_______________________________________________
Dev mailing list -- dev@xxxxxxx
To unsubscribe send an email to dev-leave@xxxxxxx

[Index of Archives]     [CEPH Users]     [Ceph Devel]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux