doc: reorganize releases #20784
doc: reorganize releases #20784
Conversation
theanalyst
force-pushed
the
docs/release-reorg
branch
from
4726c98
to
6f0522b
Compare
doc/dev/repo-access.rst
Outdated
| @@ -6,7 +6,7 @@ Special branches | |||
|
|
|||
| * ``master``: current tip (integration branch) | |||
| * Release branches (for example ``luminous``) corresponding to the releases | |||
| listed at :doc:`releases <../releases>` | |||
| listed at :doc:`releases <../releases/index>` | |||
There was a problem hiding this comment.
please don't use relative paths, try to use the :ref: directive so that when the path changes (like it is today) there is no need to update the path.
The usage of "ref" would mean that a tag will need to be in place. This is an example of setting a ref (above a title) and then consuming them in text:
.. _ceph-volume-systemd:
systemd
=======
As part of the activation process (either with :ref:`ceph-volume-lvm-activate`
or :ref:`ceph-volume-simple-activate`), systemd units will get enabled that
will use the OSD id and uuid as part of their name. These units will be run
when the system boots, and will proceed to activate their corresponding
volumes via their sub-command implementation.
|
jenkins render docs |
theanalyst
force-pushed
the
docs/release-reorg
branch
from
6f0522b
to
51acbe0
Compare
Making one file per release, and in a separate folder Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
theanalyst
force-pushed
the
docs/release-reorg
branch
from
51acbe0
to
e37e49b
Compare
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/20784/ |
|
Build is passing now, the release page is just an index of release numbers now, putting this under a major release section probably somethign like active/retired releases might make sense |
|
The links on this page currently lead to "404 - not found" errors: http://docs.ceph.com/ceph-prs/20784/releases/releases/ |
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/20784/ |
|
I'm not sure I like the release index page yet? http://docs.ceph.com/ceph-prs/20784/releases/ @liewegas @alfredodeza thoughts? |
|
First, this is a big improvement over what we had, so I'm happy if no further changes are made! That said, it would be nice if underneath Ceph Releases there was a section for each major release so that all the individual releases are grouped. Each section could include the dev releases, then the rcs, then the stable releases. The sections could be named like "Luminous 12.y.z" or "Bobtail 0.56.z" (tho for the old releases they'd include the 0.49..0.55 dev releases too, I guess... don't really care about the old ones to be honest!). |
|
@liewegas maybe 2 pages, active and archived relases is the way to go? This way we have a small index of the active releases,Mimic, Luminous, Jewel and everything else in an archived releases index. |
theanalyst
force-pushed
the
docs/release-reorg
branch
from
a9722fc
to
2aa39f0
Compare
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>
theanalyst
force-pushed
the
docs/release-reorg
branch
from
2aa39f0
to
cdf39e6
Compare
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/20784/ |
doc/install/get-packages.rst
Outdated
| @@ -83,7 +83,7 @@ You may find releases for CentOS/RHEL and others (installed with YUM) at:: | |||
|
|
|||
| https://download.ceph.com/rpm-{release-name} | |||
|
|
|||
| The major releases of Ceph are summarized at: :doc:`/releases`. | |||
| The major releases of Ceph are summarized at: :doc:`/releases/index`. | |||
There was a problem hiding this comment.
it would be great if you could use a ref here too
|
Separating "active" vs. "archived" will mean another place that needs manual updates to reflect the changes that a new release brings. We have several places already were we've tried this and it is fairly easy to fall behind. The index that groups all releases is nice though. This looks almost good to go |
|
Why is this renamed: doc/releases.rst → doc/releases/releases.rst ? It might make sense to just append the contents of that to doc/releases/index.rst since it isn't too large. If that is undesirable, then renaming the page to something else? |
|
I'll just append in index |
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>
|
Renamed to schedule actually, while I can append in index, I'd like to make the index easy to edit, the release schedule is a hairy table that is best left on its own atm :) |
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>
theanalyst
force-pushed
the
docs/release-reorg
branch
from
b0274a0
to
a933fc5
Compare
|
@alfredodeza @liewegas addressed comments jenkins render docs |
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/20784/ |
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
|
dropped older jewel rcs from the index and notes |
|
jenkins render docs |
|
Doc render available at http://docs.ceph.com/ceph-prs/20784/ |
|
@liewegas smaller index, http://docs.ceph.com/ceph-prs/20784/releases/ I guess this is a decent starting point to introduce Mimic once this goes in. Archived releases could go with a section based header (similar for active releases also probably) |
|
I'm just nitpicking now but is there a way to get rid of the "Release Index" level heading between "Ceph Releases" and the three items (schedule/active/inactive) in the nav on the left? |
|
The nav is automatically generated with a small python script that is part of the template, adjusting just for this one section is going to be tricky. A way around this would be to not list every single version released, but rather group them in another file: |
|
The links at http://docs.ceph.com/docs/master/releases/schedule/ lead to 404 - a regression I suppose? |
Making one file per release, and in a separate folder
Signed-off-by: Abhishek Lekshmanan abhishek@suse.com