diff options
| -rw-r--r-- | doc/source/index.rst | 87 | ||||
| -rw-r--r-- | doc/source/releasenotes/index.rst | 46 |
2 files changed, 34 insertions, 99 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 296165ac3..45ac090c1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,6 +1,6 @@ -============================================ -Welcome to Ironic's developer documentation! -============================================ +================================== +Welcome to Ironic's documentation! +================================== Introduction ============ @@ -16,54 +16,25 @@ with a unified interface to a heterogeneous fleet of servers while also providing the Compute service with an interface that allows physical servers to be managed as though they were virtual machines. -:doc:`An introduction to ironic's conceptual architecture <user/index>` -is available for those new to the project. - -Site Notes ----------- - -This site is primarily intended to provide documentation for developers -interested in contributing to or working with ironic. It *also* contains -references and guides for administrators which are not yet hosted elsewhere on -the OpenStack documentation sites. - This documentation is continually updated and may not represent the state of the project at any specific prior release. To access documentation for a -previous release of ironic, append the OpenStack release name to the URL, for -example: - - http://docs.openstack.org/developer/ironic/mitaka/ +previous release of ironic, append the OpenStack release name to the URL; for +example, the ``ocata`` release is available at +http://docs.openstack.org/ironic/ocata/. - -Bare Metal API References -========================= - -Ironic's REST API has changed since its first release, and continues to evolve -to meet the changing needs of the community. Here we provide a conceptual -guide as well as more detailed reference documentation. +User Guide +========== .. toctree:: - :maxdepth: 1 - - API Concept Guide <contributor/webapi> - API Reference (latest) <http://developer.openstack.org/api-ref/baremetal/> - API Reference (latest) <api/index> - API Version History <contributor/webapi-version-history> + :maxdepth: 2 + user/index -Contributor's Guide +Administrator Guide =================== .. toctree:: - :maxdepth: 2 - - contributor/index - -Administrator's Guide -===================== - -.. toctree:: - :maxdepth: 1 + :maxdepth: 2 admin/index @@ -79,6 +50,20 @@ driver. These pages are linked below. Driver Documentation pages <admin/drivers> Further Considerations for the Agent Drivers <admin/drivers/ipa> +Bare Metal API References +========================= + +Ironic's REST API has changed since its first release, and continues to evolve +to meet the changing needs of the community. Here we provide a conceptual +guide as well as more detailed reference documentation. + +.. toctree:: + :maxdepth: 1 + + API Concept Guide <contributor/webapi> + API Reference (latest) <http://developer.openstack.org/api-ref/baremetal/> + API Version History <contributor/webapi-version-history> + Command References ================== @@ -89,20 +74,16 @@ Here are references for commands not elsewhere documented. cli/index +Contributor Guide +================= + +.. toctree:: + :maxdepth: 2 + + contributor/index + Indices and tables ================== * :ref:`genindex` * :ref:`search` - -.. # NOTE(jaegerandi): This is where we hide things that we don't want - # shown in the top level table of contents. - # user/index is referenced above but not in a toctree. -.. toctree:: - :hidden: - - admin/install-guide.rst - user/index - releasenotes/index - webapi/v1.rst - admin/index diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst deleted file mode 100644 index 727a43677..000000000 --- a/doc/source/releasenotes/index.rst +++ /dev/null @@ -1,46 +0,0 @@ -============= -Release Notes -============= - -The official location for release notes is: -http://docs.openstack.org/releasenotes/ironic. - -This page is old and not up-to-date but retained to prevent links to this -page from breaking. - -4.2.1 -===== - -Release notes: http://docs.openstack.org/releasenotes/ironic/liberty.html#V4-2-1 - -4.2.0 -===== - -Release notes: http://docs.openstack.org/releasenotes/ironic/liberty.html#V4-2-0 - -4.1.0 -===== - -Release notes: http://docs.openstack.org/releasenotes/ironic/liberty.html#V4-1-0 - -4.0.0 First semver release -============================ - -Release notes: http://docs.openstack.org/releasenotes/ironic/liberty.html#V4.0.0 - -2015.1.0 OpenStack "Kilo" Release -==================================== - -Release notes: https://wiki.openstack.org/wiki/ReleaseNotes/Kilo#OpenStack_Bare_Metal_service_.28Ironic.29 - - -2014.2.0 OpenStack "Juno" Release -==================================== - -Release notes: https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Juno - -2014.1.0 OpenStack "Icehouse" Release -======================================== - -Release notes: https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Icehouse - |