openstack
/
charm-guide
Code Issues Proposed changes

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
This commit is contained in:
Ryan Beisner 2017-11-27 18:05:45 +00:00
parent df551e05e8
commit 0540942725
10 changed files with 143 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
HACKING.rst Normal file
View File

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

45
doc/source/charm-release.rst
View File

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

1
doc/source/charm-release.rst Symbolic link
View File

@ -0,0 +1 @@
release-policy.rst

14
doc/source/deployment.rst
View File

@ -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 <openstack-on-lxd.html>`__ 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 <charm-store.html>`__ 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 <https://docs.openstack.org/charm-deployment-guide/latest/>
.. _Charm Deployment Guide: https://docs.openstack.org/charm-deployment-guide/latest/

2
doc/source/find-us.rst
View File

@ -6,7 +6,7 @@ Talk to us
* Talk to us on IRC channel ``#openstack-charms`` on Freenode.
* Join the conversation on our `Mailing list <http://docs.openstack.org/developer/charm-guide/mailing-list.html>`_.
* Participate to our `Online Meetings <http://docs.openstack.org/developer/charm-guide/meetings.html>`_.
* Participate to our `Online Meetings <meetings.html>`_.
.. toctree::

3
doc/source/how-to-contribute.rst
View File

@ -19,4 +19,5 @@ to the OpenStack Charms.
making-a-change
creating-charms
backport-policy
reviews
Gerrit Reviewable Items <https://review.openstack.org/#/q/project:%22%255Eopenstack/charm.*%22+status:open+label:Verified%252B1+NOT+label:Verified-1+NOT+label:Code-Review-1>
Gerrit All Open Items <https://review.openstack.org/#/q/project:%22%255Eopenstack/charm.*%22+status:open>

7
doc/source/index.rst
View File

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

27
doc/source/release-notes.rst Normal file
View File

@ -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 <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1607>`__
* `16.04 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1604>`__
* `16.01 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1601>`__
* `15.10 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1510>`__
* `15.07 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1507>`__
* `15.04 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1504>`__
* `15.01 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1501>`__
* `14.10 release <https://wiki.ubuntu.com/UtopicUnicorn/ReleaseNotes/OpenStackCharms>`__
* `14.04 release <https://wiki.ubuntu.com/TrustyTahr/ReleaseNotes/OpenStackCharms>`__
.. toctree::
:maxdepth: 1
:hidden:
1708
1702
1610

45
doc/source/release-policy.rst Normal file
View File

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

41
doc/source/release-schedule.rst Normal file
View File

@ -0,0 +1,41 @@
================
Release Schedule
================
Per the cadence and other requirements defined in the OpenStack Charms `Release Policy <release-policy.html>`__
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 <https://releases.openstack.org/queens/schedule.html>`__.
+---------+-------------------+
| 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 |
+---------+-------------------+

27
doc/source/releases.rst
View File

@ -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 <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1607>`__
* `16.04 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1604>`__
* `16.01 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1601>`__
* `15.10 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1510>`__
* `15.07 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1507>`__
* `15.04 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1504>`__
* `15.01 release <https://wiki.ubuntu.com/OpenStack/OpenStackCharms/ReleaseNotes1501>`__
* `14.10 release <https://wiki.ubuntu.com/UtopicUnicorn/ReleaseNotes/OpenStackCharms>`__
* `14.04 release <https://wiki.ubuntu.com/TrustyTahr/ReleaseNotes/OpenStackCharms>`__
.. toctree::
:maxdepth: 1
:hidden:
1610
1702
1708

1
doc/source/releases.rst Symbolic link
View File

@ -0,0 +1 @@
release-notes.rst