From 05409427257ca684477cfb31d30bdfb7f7e11d99 Mon Sep 17 00:00:00 2001 From: Ryan Beisner Date: Mon, 27 Nov 2017 18:05:45 +0000 Subject: [PATCH] Add deploy guide link and release schedules Re-arrange index to include more general info toward the top. Re-order release note links in the index to be consistent, with the latest at the top. Add a summary description of each of the deploy references. Fix broken link from find-us.html to Online Meetings. Fix broken 'reviews' reference from how-to-contribute.html. Change-Id: Id44d609d4e083b68c9a35db6798f59195a986906 --- HACKING.rst | 7 +++++ doc/source/charm-release.rst | 46 +------------------------------- doc/source/deployment.rst | 14 ++++++++++ doc/source/find-us.rst | 2 +- doc/source/how-to-contribute.rst | 3 ++- doc/source/index.rst | 7 ++--- doc/source/release-notes.rst | 27 +++++++++++++++++++ doc/source/release-policy.rst | 45 +++++++++++++++++++++++++++++++ doc/source/release-schedule.rst | 41 ++++++++++++++++++++++++++++ doc/source/releases.rst | 28 +------------------ 10 files changed, 143 insertions(+), 77 deletions(-) create mode 100644 HACKING.rst mode change 100644 => 120000 doc/source/charm-release.rst create mode 100644 doc/source/release-notes.rst create mode 100644 doc/source/release-policy.rst create mode 100644 doc/source/release-schedule.rst mode change 100644 => 120000 doc/source/releases.rst diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 00000000..d85a9dd4 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,7 @@ +Hacking Notes +############# + +NOTE (beisner): While rearranging things to make the release sections +more consistent, I've added symlinks to ensure the old html file names +are still rendered and served to those with old bookmarks. Otherwise +users would experience 404. diff --git a/doc/source/charm-release.rst b/doc/source/charm-release.rst deleted file mode 100644 index af10e5ff..00000000 --- a/doc/source/charm-release.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. _charm-release: - -Release Policy -============== - -The OpenStack charm repositories are all tagged as `release:independent`; however the -OpenStack Charms project does have a regular release cadence which makes specific demands -on the charms in terms of development and testing. - -The OpenStack Charms team produces a release every 3 months, with every other release -aligned to the main OpenStack release. - -To be included as part of a release, the (sub)team supporting a charm must meet the -following release requirements: - -1. Support for the latest OpenStack release, if the charm release is aligned to the - main OpenStack release cadence; this means that supporting projects need to produce - supporting releases alongside the main OpenStack release. - -2. Charms must include functional tests to be eligible for inclusion in the official - OpenStack Charm release every 3 months; these are typically implemented as - Amulet tests within each charm. - -3. Charms must have an active and responsive community of developers. - -4. Charms should provide 3rd party CI where it's not possible to provide functional - testing of charms using standard OpenStack Cloud resources; examples of this might - include (but are not limited to) SDN and Storage integrations that rely on - specific vendor hardware or proprietary software. - -Charms which don't meet these requirements can continue to be part of the -OpenStack Charms project, but won't form part of the official 3 monthly charm -release. This approach allows new charms to incubate as part of the wider -OpenStack Charms project, with inclusion in the 3-monthly release when this -policy is met. - -Charms may choose to opt-out of the co-ordinated charm release, and follow -a more independent release approach - this may be appropriate for supporting -charms in the wider OpenStack ecosystem which are not aligned to the main -OpenStack release cycle. - -This policy is broadly based on the Charm Store 'curated charm' policy adopted -by the wider charm community, and as such charms not meeting the OpenStack -Charms release policy will not form part of the curated charm set on the -Juju Charm Store. diff --git a/doc/source/charm-release.rst b/doc/source/charm-release.rst new file mode 120000 index 00000000..b842d861 --- /dev/null +++ b/doc/source/charm-release.rst @@ -0,0 +1 @@ +release-policy.rst \ No newline at end of file diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst index 5c8a2f1d..07094b33 100644 --- a/doc/source/deployment.rst +++ b/doc/source/deployment.rst @@ -6,13 +6,27 @@ In order to test or develop using the OpenStack charms, you'll need to prepare an environment where you can deploy and test OpenStack services deployed using charms. +The `OpenStack-on-LXD `__ procedure provides an +all-in-one machine approach to deploying for the purpose of charm testing, +package exercises, and architecture validation. + +The `Deploying from the Charm Store `__ section describes +the basics on deploying a bundle or charm from the charm store. + +The `Charm Deployment Guide`_ provides a more in-depth guide to deploying a +multi-node OpenStack cloud with Juju, MAAS, and OpenStack Charms. + This part of the Charm guide details methods for getting started in this area, with anything from a single laptop, through to a full multi-server environment managed using MAAS. + .. toctree:: :titlesonly: :maxdepth: 1 openstack-on-lxd charm-store + Charm Deployment Guide + +.. _Charm Deployment Guide: https://docs.openstack.org/charm-deployment-guide/latest/ diff --git a/doc/source/find-us.rst b/doc/source/find-us.rst index 7a28ab32..da18575b 100644 --- a/doc/source/find-us.rst +++ b/doc/source/find-us.rst @@ -6,7 +6,7 @@ Talk to us * Talk to us on IRC channel ``#openstack-charms`` on Freenode. * Join the conversation on our `Mailing list `_. -* Participate to our `Online Meetings `_. +* Participate to our `Online Meetings `_. .. toctree:: diff --git a/doc/source/how-to-contribute.rst b/doc/source/how-to-contribute.rst index 163c5fdd..8a1abd7a 100644 --- a/doc/source/how-to-contribute.rst +++ b/doc/source/how-to-contribute.rst @@ -19,4 +19,5 @@ to the OpenStack Charms. making-a-change creating-charms backport-policy - reviews + Gerrit Reviewable Items + Gerrit All Open Items diff --git a/doc/source/index.rst b/doc/source/index.rst index 7c5ca78d..a0bf63ff 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,15 +10,16 @@ with lose coupling between OpenStack Services. :includehidden: getting-started + find-us deployment openstack-charms creating-charms how-to-contribute author-guides/index rotas - charm-release - find-us - releases + release-policy + release-schedule + release-notes ==================== Indices and tables diff --git a/doc/source/release-notes.rst b/doc/source/release-notes.rst new file mode 100644 index 00000000..28edf506 --- /dev/null +++ b/doc/source/release-notes.rst @@ -0,0 +1,27 @@ +============= +Release Notes +============= + +Latest Release Notes + * `17.08 release <1708.html>`__ + +Older release notes + * `17.02 release <1702.html>`__ + * `16.10 release <1610.html>`__ + * `16.07 release `__ + * `16.04 release `__ + * `16.01 release `__ + * `15.10 release `__ + * `15.07 release `__ + * `15.04 release `__ + * `15.01 release `__ + * `14.10 release `__ + * `14.04 release `__ + +.. toctree:: + :maxdepth: 1 + :hidden: + + 1708 + 1702 + 1610 diff --git a/doc/source/release-policy.rst b/doc/source/release-policy.rst new file mode 100644 index 00000000..af10e5ff --- /dev/null +++ b/doc/source/release-policy.rst @@ -0,0 +1,45 @@ +.. _charm-release: + +Release Policy +============== + +The OpenStack charm repositories are all tagged as `release:independent`; however the +OpenStack Charms project does have a regular release cadence which makes specific demands +on the charms in terms of development and testing. + +The OpenStack Charms team produces a release every 3 months, with every other release +aligned to the main OpenStack release. + +To be included as part of a release, the (sub)team supporting a charm must meet the +following release requirements: + +1. Support for the latest OpenStack release, if the charm release is aligned to the + main OpenStack release cadence; this means that supporting projects need to produce + supporting releases alongside the main OpenStack release. + +2. Charms must include functional tests to be eligible for inclusion in the official + OpenStack Charm release every 3 months; these are typically implemented as + Amulet tests within each charm. + +3. Charms must have an active and responsive community of developers. + +4. Charms should provide 3rd party CI where it's not possible to provide functional + testing of charms using standard OpenStack Cloud resources; examples of this might + include (but are not limited to) SDN and Storage integrations that rely on + specific vendor hardware or proprietary software. + +Charms which don't meet these requirements can continue to be part of the +OpenStack Charms project, but won't form part of the official 3 monthly charm +release. This approach allows new charms to incubate as part of the wider +OpenStack Charms project, with inclusion in the 3-monthly release when this +policy is met. + +Charms may choose to opt-out of the co-ordinated charm release, and follow +a more independent release approach - this may be appropriate for supporting +charms in the wider OpenStack ecosystem which are not aligned to the main +OpenStack release cycle. + +This policy is broadly based on the Charm Store 'curated charm' policy adopted +by the wider charm community, and as such charms not meeting the OpenStack +Charms release policy will not form part of the curated charm set on the +Juju Charm Store. diff --git a/doc/source/release-schedule.rst b/doc/source/release-schedule.rst new file mode 100644 index 00000000..a2bae4c3 --- /dev/null +++ b/doc/source/release-schedule.rst @@ -0,0 +1,41 @@ +================ +Release Schedule +================ + +Per the cadence and other requirements defined in the OpenStack Charms `Release Policy `__ +section, the following outlines the up-coming feature freeze and stable +charm release dates. Dates are estimated and anticipated, and are subject +to being blocked or delayed by critical regressions or critical bugs +introduced at master. + + +18.05 Stable Charm Release +########################## + ++---------+-------------------+ +| Freeze | Tue, May 15, 2018 | ++---------+-------------------+ +| Release | Thu, May 24, 2018 | ++---------+-------------------+ + + +18.02 Stable Charm Release +########################## + +This release will align approximately with the `OpenStack Queens Release Schedule `__. + ++---------+-------------------+ +| Freeze | Thu, Feb 15, 2018 | ++---------+-------------------+ +| Release | Wed, Feb 28, 2018 | ++---------+-------------------+ + + +17.11 Stable Charm Release +########################## + ++---------+-------------------+ +| Freeze | Tue, Nov 21, 2017 | ++---------+-------------------+ +| Release | Wed, Nov 30, 2017 | ++---------+-------------------+ diff --git a/doc/source/releases.rst b/doc/source/releases.rst deleted file mode 100644 index 6b865180..00000000 --- a/doc/source/releases.rst +++ /dev/null @@ -1,27 +0,0 @@ -============= -Release Notes -============= - -Latest Release Notes - * `17.08 release <1708.html>`__ - -Older release notes - * `17.02 release <1702.html>`__ - * `16.10 release <1610.html>`__ - * `16.07 release `__ - * `16.04 release `__ - * `16.01 release `__ - * `15.10 release `__ - * `15.07 release `__ - * `15.04 release `__ - * `15.01 release `__ - * `14.10 release `__ - * `14.04 release `__ - -.. toctree:: - :maxdepth: 1 - :hidden: - - 1610 - 1702 - 1708 diff --git a/doc/source/releases.rst b/doc/source/releases.rst new file mode 120000 index 00000000..b02a787f --- /dev/null +++ b/doc/source/releases.rst @@ -0,0 +1 @@ +release-notes.rst \ No newline at end of file