We've been keeping a backlog of specs which are entirely outdated
and will never be implemented. And we should also indicate when
a specification document is no longer applicable at all. As such
this change adds a retired folder, enumeration, and moves four
documents to the retired folder to indcate they are no longer
applicable to Ironic so end users have appropriate context should
they discover the documents in the future.
Change-Id: I1ab7d6726dc45283ca72df1df1d3c18e8ae8ea94
Ironic contributors discussed a lot of potential work for 2023.1.
This documents them in a place for stakeholders.
Change-Id: I6c7a3182cb2c51e89325614953d4fad086ba1433
This document is an attempt to capture the consensus aspects from
team's PTG sessions and to convey the consensus outward.
Some items on the list from the PTG were removed, and wording
has also been changed to use the word themes instead of priorities.
Change-Id: I375ed65feba96aa693efc17b338b5fae401edfbd
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ifc57df7591d861508e761b8accc56efd32d762bc
We've released 11.0 and about to release 11.1,
and a number of new features landed in that which
means we can close out the specs in our spec
documentation.
As for rescue, we finally managed to get the rescue
patch landed in nova, and as such moved to the 10.1
folder.
Change-Id: I450784e7281e0d251c5f230b2d14be244e6c083f
The ansible deploy hardware type was finished in Queens 10.1 release
and the additional capabilities were added to ironic inspection in
Pike 9.2 release.
Change-Id: I0ce54a7afbbfb0deb1794bab2abea85def6bff7f
This moves the specs that were completed towards the end of
the Pike cycle, to the 9.0 release folder. Due to the race-condition
bug in rolling upgrades, we consider that feature completed in 9.1.
Change-Id: I1dabd2124e15184d5a7f829c52f6fa1bfd66edc0
This adds a Pike/8.0 section and moves these features to 8.0
since they are done and will be available in 8.0:
- redfish hardware type and interfaces
- OSC commands to get descrptions of driver-related information
Change-Id: If67a0c8036fbb7af368aed8384b6b74569500230
Adds a 7.0 (Ocata) directory and moves the specs that
were implemented in Ocata to that directory.
Also moves the 'Collect logs from agent ramdisk' to
6.2 directory since it was completed then.
Change-Id: Id5d0ffb3c13a7ed2451c5c5f77c4b7567aef396e
These are completed.
Note that the OSC plugin spec and the third party CI spec aren't
necessarily tied to 6.2, however I don't have a better place to put
them, and this sufficiently communicates the timeframe they were
completed in, so I'm rolling with it.
Change-Id: If1efb7d8babb9171c508e1ad5f9fe1e95fc278f8
Place priorities list in reverse chronological order
It is now:
* Newton Priorities
* Mitaka Priorities
Usually people are concerned with the most recent priorities.
Change-Id: I6632c4e7f95a6896352ee4b3de56422ddf475407
This update adds 5.0/ and 5.1/ directories, moves the symlinks for
completed specs into them, and updates the index.html page to reflect
the completion of the Mitaka cycle.
It also moves te partition-image-support-for-agent-driver from the
backlog to the approved directory, since the work was actually
completed, and updates the spec to include two missing (and unaffected)
sections.
Change-Id: Ice187410798a4d93044095dd476792d919222701
When specs are approved but not yet implemented, they reside in
specs/approved. After implementation, we have been moving them to
specs/<release>-implemented. Which means that any links to specs
in specs/approved are broken.
This patch leaves the specs in specs/approved, and adds a new
specs/not-implemented directory that contains soft links to all the
approved-but-not-yet-implemented specs that reside in specs/approved.
For specs that were implemented, e.g. in release 4.3, a specs/4.3
directory is created with soft links to the implemented specs (that still
reside in specs/approved).
Since we are using links to files, the specs cannot have labels
because sphinx warns of duplicate labels.
Change-Id: Icd81d68cec4bbfaa3b20e370ba1b31edb32ae1d1
This adds a document laying out our priorities for the Mitaka cycle,
inspired by what Nova does. It also refactors the index page to add the
priorities tree.
Change-Id: I95bf7e119d8c56c58abd4f8ebab80cc8a98373ff
Now that we have semver-versioned releases of ironic, it would be
useful to show which specifications were implemented in each
release.
New subdirectories 4.0 & 4.2 are created for each ironic release
during the Liberty development cycle (where any blueprints were
implemented) and symbolic links are added to the actual
specification files in liberty-implemented/.
The specifications at liberty-implemented/ are still generated and
available at that older URL location, but we don't put any explicit
links to those older URLs in the index.
Change-Id: I3e74d6055c4d56a56e54d0f34b53e0a695c3bb50
This removes the Placeholders section from the main specs page.
We need to have the old URLs available so that external references
to them still work, but we don't want to encourage people to use
those links.
Change-Id: I4d237f85518bce699c20cb3720faec5233272c92
This reorganizes the specs on the main page
(http://specs.openstack.org/openstack/ironic-specs/)
so that it is clearer as to which specs have been
approved (but not implemented) and which specs
were implemented (and in which development cycle).
Since specs that were approved, but not implemented in the same
cycle as the approval, do not have to be re-submitted, there
doesn't seem to be much value to having 'Current Cycle' as a
header.
Change-Id: I71e4fa1e60cfed114a8cc051a774a9d148fbbd8a
This commit adds a placeholder with link to the new location for each of
the specs that were moved by the previous commit. It also adds a
"placeholder" file containing TOC-style references to the old
directories, and a link to this on the index page.
This is broken into two commits to preserve the history; git can't
recognize a rename and replace operation in the same commit.
Change-Id: Ieea08e7b477993baaca76b14210547e3e26c2935
Co-authored-by: Jim Rollenhagen <jim@jimrollenhagen.com>
* Move liberty -> approved
* Move completed liberty specs to liberty-implemented
* Move kilo -> kilo-implemented
* Move juno -> juno-implemented
* Move kilo-archive -> backlog (moving these to approved causes test
failures because the template changed since kilo)
* Reword the header for the index page
* Update unit tests to look at the new "approved" folder
** NOTE **
This patch does not create placeholders in the previous locations
for each spec. This will be done in the following patch so that the
history is preserved. Both patches must be landed together so that web
links are not broken for long.
Change-Id: I61f02731150ea944eafaa8c6ea702210364b3478
Implements: blueprint feature-based-releases
This updates the template to ask about microversions, as well as
creating the liberty/ dir with a placeholder spec which should be
removed once we have merged an approved spec for Liberty.
Additionally, all specs from Kilo that were not implemented have
been archived. If they wish to be revived for Liberty, a separate
merge request should be issued moving them into liberty/.
Change-Id: I839b478a67af9eab3bfefbf979227e5f49b01aed
* Clarify the template to describe the requirements and process for
submitting initial drafts better.
* Add testing for a specs/backlog dir which allows "short specs"
to be accepted in that dir even if they are missing some sections.
* Add a sample file to the specs/backlog dir, for demonstration.
* Update the index page
Change-Id: I634635467f5cbe565958dbcd360399bc5f0b96ec
This adds the entries in the index so that the main page will
list the specs in specs/kilo. To get sphinx to not err, a dummy
.rst file (based on the template.rst) was added to specs/kilo.
It should be deleted after we have an approved spec.
Without this temporary fix, all spec patches will basically
need to have the change in index.rst; otherwise Jenkins will
not be happy.
Note that the dummy .rst file needs to be added or sphinx will
complain because the specs/kilo/* pattern didn't match any
documents. Furthermore, the .rst file there must be valid
(based on the template) or the unit tests will fail. And lastly,
that dummy .rst file cannot be named 'template.rst' because
we've configured it to ignore all files named 'template.rst'. If
that is ignored, we're back to no files in specs/kilo, and sphinx
will be unhappy again.
Closes-Bug: #1379415
Change-Id: Ic4a40a5b085073bc9eebc3d2c75432f18f01cbef