opendev/system-config
Code Issues Proposed changes
b5266ea20c
system-config/doc/source/index.rst

47 lines
1.0 KiB
ReStructuredText
Raw Normal View History

Rename CI to Infra in MANY MANY places. Change-Id: I409bd50ae374e0288531f07cfeea34856c5f8067 Reviewed-on: https://review.openstack.org/17319 Approved: James E. Blair <corvus@inaugust.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Tested-by: James E. Blair <corvus@inaugust.com>
2012-12-02 11:52:32 -08:00
OpenStack Project Infrastructure
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
================================
This documentation covers the installation and maintenance of the
Refactor project infrastructure docs. The goal is to re-orient the documentation as an introduction for new contributors and a reference for all contributors. Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff Reviewed-on: https://review.openstack.org/30515 Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Reviewed-by: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
2013-05-24 16:56:35 -07:00
project infrastructure used by OpenStack. It may be of interest to
people who may want to help develop this infrastructure or integrate
their tools into it. Some instructions may be useful to other
Fix spelling error on infrastructure docs * index.rst: Fix "infrastrucutre" to say "infrastructure" in last paragraph Change-Id: Ie5ae5f312cb7f64ee2b64e81380d5bf9f0f9076e
2013-10-15 21:37:05 -07:00
projects that want to set up similar infrastructure systems for their
Refactor project infrastructure docs. The goal is to re-orient the documentation as an introduction for new contributors and a reference for all contributors. Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff Reviewed-on: https://review.openstack.org/30515 Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Reviewed-by: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
2013-05-24 16:56:35 -07:00
developers.
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
OpenStack developers or users do not need to read this documentation.
Rework intro Do not link to wiki but instead to special purpose pages - infra manual for developers, docs main page for users. Change-Id: Ic8c1aa5ce6b81f9b936290db68f357d6574b9a0e
2017-03-31 20:48:59 +02:00
Instead, see the `Infra Manual <https://docs.openstack.org/infra/manual/>`_
to learn how contribute to or the `OpenStack documentation
[doc] Fix incorrect external link markup Change-Id: I7efe2b697c0045444cc21daaffd0c3eb6cbacadf
2017-05-16 10:15:10 +09:00
<https://docs.openstack.org/>`_ on how to use OpenStack.
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
Fix navigation order with HOWTOs Move the toctree from the HOWTOs sidebar on the front page to a hidden toctree after the main toctree. Create manual links to the HOWTOs docs in the sidebar. This fixes the fact that the "next" link in the docs navigated to one of the sidebars first, instead of the introductory "Infrastructure Project" doc, while keeping those sidebars in the toctree navigation so if someone reads the docs straight through they get every page. Change-Id: I5e1c23b7d3ce324bbd9e333cf6e898b33601982e Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com> Reviewed-on: https://review.openstack.org/32630 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
2013-06-11 15:15:20 -04:00
Contents:
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
Fix navigation order with HOWTOs Move the toctree from the HOWTOs sidebar on the front page to a hidden toctree after the main toctree. Create manual links to the HOWTOs docs in the sidebar. This fixes the fact that the "next" link in the docs navigated to one of the sidebars first, instead of the introductory "Infrastructure Project" doc, while keeping those sidebars in the toctree navigation so if someone reads the docs straight through they get every page. Change-Id: I5e1c23b7d3ce324bbd9e333cf6e898b33601982e Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com> Reviewed-on: https://review.openstack.org/32630 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
2013-06-11 15:15:20 -04:00
.. sidebar:: HOWTOs
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
Fix navigation order with HOWTOs Move the toctree from the HOWTOs sidebar on the front page to a hidden toctree after the main toctree. Create manual links to the HOWTOs docs in the sidebar. This fixes the fact that the "next" link in the docs navigated to one of the sidebars first, instead of the introductory "Infrastructure Project" doc, while keeping those sidebars in the toctree navigation so if someone reads the docs straight through they get every page. Change-Id: I5e1c23b7d3ce324bbd9e333cf6e898b33601982e Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com> Reviewed-on: https://review.openstack.org/32630 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
2013-06-11 15:15:20 -04:00
* :doc:`third_party`
Properly deprecate stackforge We still have a stackforge doc. The TC deprecated this term forever ago so lets stop using it. https://governance.openstack.org/tc/resolutions/20160119-stackforge-retirement.html has all the governance details. Change-Id: I537f239dfd7adde2d6c082cc4ecef59c485d789e
2018-03-19 11:23:22 -07:00
* :doc:`unofficial_project_hosting`
Add doc on contributing cloud resources Change-Id: Ic60c6ebffdb2ea0d2df0f08544c40a5f5fb859d8
2015-07-27 15:36:55 -07:00
* :doc:`contribute-cloud`
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
.. toctree::
:maxdepth: 2
Refactor project infrastructure docs. The goal is to re-orient the documentation as an introduction for new contributors and a reference for all contributors. Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff Reviewed-on: https://review.openstack.org/30515 Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Reviewed-by: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
2013-05-24 16:56:35 -07:00
project
Document what it takes to be a check/gate test. This is my recollection of the consensus from some infra folk on a train late at night: it's probably wrong, but I wanted something I can point contributors at. Change-Id: Ic1ad99335ce41481995322f0ee5daadb08a09c2a
2013-11-11 09:26:53 +13:00
test-infra-requirements
Refactor project infrastructure docs. The goal is to re-orient the documentation as an introduction for new contributors and a reference for all contributors. Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff Reviewed-on: https://review.openstack.org/30515 Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Reviewed-by: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
2013-05-24 16:56:35 -07:00
sysadmin
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
systems
Generate roles documentation Since we're building out roles in system-config now, generate documentation. We look in roles/* and playbook/roles/* (follow-on changes will split things up between the two). Correct the reference names in the exim documentation to avoid warnings and failure. This also revealed a single unicode character in the exim readme (which caused prior versions of zuul-sphinx to barf). For fun, see if you can find it! Depends-On: https://review.openstack.org/#/c/579474/ Change-Id: I243a96bbd6d09560f8aa80b6345b90039422547a
2018-08-20 13:32:23 +10:00
roles
Refactor project infrastructure docs. The goal is to re-orient the documentation as an introduction for new contributors and a reference for all contributors. Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff Reviewed-on: https://review.openstack.org/30515 Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Approved: Monty Taylor <mordred@inaugust.com> Reviewed-by: Monty Taylor <mordred@inaugust.com> Tested-by: Jenkins
2013-05-24 16:56:35 -07:00
Fix navigation order with HOWTOs Move the toctree from the HOWTOs sidebar on the front page to a hidden toctree after the main toctree. Create manual links to the HOWTOs docs in the sidebar. This fixes the fact that the "next" link in the docs navigated to one of the sidebars first, instead of the introductory "Infrastructure Project" doc, while keeping those sidebars in the toctree navigation so if someone reads the docs straight through they get every page. Change-Id: I5e1c23b7d3ce324bbd9e333cf6e898b33601982e Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com> Reviewed-on: https://review.openstack.org/32630 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
2013-06-11 15:15:20 -04:00
.. toctree::
:hidden:
Properly deprecate stackforge We still have a stackforge doc. The TC deprecated this term forever ago so lets stop using it. https://governance.openstack.org/tc/resolutions/20160119-stackforge-retirement.html has all the governance details. Change-Id: I537f239dfd7adde2d6c082cc4ecef59c485d789e
2018-03-19 11:23:22 -07:00
unofficial_project_hosting
Add missing running-your-own hidden toctree. Change-Id: If642c7e2c96b3e54b55df5f9bd041a7e30304c04
2013-11-11 09:01:27 +13:00
third_party
Add doc on contributing cloud resources Change-Id: Ic60c6ebffdb2ea0d2df0f08544c40a5f5fb859d8
2015-07-27 15:36:55 -07:00
contribute-cloud
Fix navigation order with HOWTOs Move the toctree from the HOWTOs sidebar on the front page to a hidden toctree after the main toctree. Create manual links to the HOWTOs docs in the sidebar. This fixes the fact that the "next" link in the docs navigated to one of the sidebars first, instead of the introductory "Infrastructure Project" doc, while keeping those sidebars in the toctree navigation so if someone reads the docs straight through they get every page. Change-Id: I5e1c23b7d3ce324bbd9e333cf6e898b33601982e Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com> Reviewed-on: https://review.openstack.org/32630 Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com> Approved: Jeremy Stanley <fungi@yuggoth.org> Reviewed-by: Jeremy Stanley <fungi@yuggoth.org> Tested-by: Jenkins
2013-06-11 15:15:20 -04:00
Merge in docs from openstack-ci. Change-Id: I49f71f8118e45f28d4b777ddc9588b8e30151d79
2012-05-15 17:21:49 -04:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Copy Permalink