Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: reorganize releases #20784

Merged
merged 6 commits into from Mar 19, 2018

Conversation

Projects
None yet
7 participants
@theanalyst
Copy link
Member

commented Mar 7, 2018

Making one file per release, and in a separate folder

Signed-off-by: Abhishek Lekshmanan abhishek@suse.com

@theanalyst theanalyst requested review from alfredodeza and liewegas Mar 7, 2018

@theanalyst theanalyst force-pushed the theanalyst:docs/release-reorg branch from 4726c98 to 6f0522b Mar 7, 2018

@@ -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>`

This comment has been minimized.

Copy link
@alfredodeza

alfredodeza Mar 7, 2018

Contributor

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.

This comment has been minimized.

Copy link
@theanalyst

theanalyst Mar 7, 2018

Author Member

thanks fixing

@liewegas

This comment has been minimized.

Copy link
Member

commented Mar 7, 2018

jenkins render docs

@theanalyst theanalyst force-pushed the theanalyst:docs/release-reorg branch from 6f0522b to 51acbe0 Mar 7, 2018

doc: reorganize releases
Making one file per release, and in a separate folder

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>

@theanalyst theanalyst force-pushed the theanalyst:docs/release-reorg branch from 51acbe0 to e37e49b Mar 7, 2018

doc: add releases to conf.py
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 7, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Mar 7, 2018

Doc render available at http://docs.ceph.com/ceph-prs/20784/

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 8, 2018

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

@LenzGr

This comment has been minimized.

Copy link
Contributor

commented Mar 8, 2018

The links on this page currently lead to "404 - not found" errors: http://docs.ceph.com/ceph-prs/20784/releases/releases/

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Mar 12, 2018

Doc render available at http://docs.ceph.com/ceph-prs/20784/

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2018

I'm not sure I like the release index page yet? http://docs.ceph.com/ceph-prs/20784/releases/ @liewegas @alfredodeza thoughts?

@liewegas

This comment has been minimized.

Copy link
Member

commented Mar 12, 2018

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!).

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2018

@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 theanalyst force-pushed the theanalyst:docs/release-reorg branch from a9722fc to 2aa39f0 Mar 12, 2018

doc: releases archive older releases
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>

@theanalyst theanalyst force-pushed the theanalyst:docs/release-reorg branch from 2aa39f0 to cdf39e6 Mar 12, 2018

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 12, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Mar 12, 2018

Doc render available at http://docs.ceph.com/ceph-prs/20784/

@@ -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`.

This comment has been minimized.

Copy link
@alfredodeza

alfredodeza Mar 13, 2018

Contributor

it would be great if you could use a ref here too

This comment has been minimized.

Copy link
@theanalyst

theanalyst Mar 13, 2018

Author Member

ack

@alfredodeza

This comment has been minimized.

Copy link
Contributor

commented Mar 13, 2018

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

@alfredodeza

This comment has been minimized.

Copy link
Contributor

commented Mar 13, 2018

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? /releases/releases/ is a bit odd

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 13, 2018

I'll just append in index

doc: rename releases->schedule
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>
@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 13, 2018

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 :)

doc: fix index reference
Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>

@theanalyst theanalyst force-pushed the theanalyst:docs/release-reorg branch from b0274a0 to a933fc5 Mar 14, 2018

@theanalyst theanalyst changed the title wip: doc: reorganize releases doc: reorganize releases Mar 14, 2018

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2018

@alfredodeza @liewegas addressed comments

jenkins render docs

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Mar 14, 2018

Doc render available at http://docs.ceph.com/ceph-prs/20784/

doc: releases/jewel drop older RCs/dev releases from notes
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2018

dropped older jewel rcs from the index and notes

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2018

jenkins render docs

@ceph-jenkins

This comment has been minimized.

Copy link
Collaborator

commented Mar 14, 2018

Doc render available at http://docs.ceph.com/ceph-prs/20784/

@theanalyst

This comment has been minimized.

Copy link
Member Author

commented Mar 14, 2018

@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)

@liewegas
Copy link
Member

left a comment

lgtm!

@liewegas

This comment has been minimized.

Copy link
Member

commented Mar 14, 2018

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?

@alfredodeza

This comment has been minimized.

Copy link
Contributor

commented Mar 14, 2018

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:

releases/active/luminous
releases/active/jewel

@theanalyst theanalyst merged commit c9091ab into ceph:master Mar 19, 2018

6 checks passed

Docs: build check OK - docs built
Details
Docs: render build OK - docs rendered
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check make check succeeded
Details
make check (arm64) make check succeeded
Details
@makomatic

This comment has been minimized.

Copy link

commented Jun 1, 2018

The links at http://docs.ceph.com/docs/master/releases/schedule/ lead to 404 - a regression I suppose?

@tchaikov

This comment has been minimized.

Copy link
Contributor

commented Jun 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.