24 Commits

Author SHA1 Message Date
Ian Wienand
4c86706e5e docs: reorganise around a open infrastructure overview
This introduces and "Open Infrastructure" page which is designed for a
moderately experienced developer with some understanding of Zuul,
Ansible and basic Linux admin skills to have an entrypoint to
navigating the system-config and related repositories.

It is designed to re-enforce the idea of open infrastructure, and
explain how development, testing and production come together at a
level high enough to be understood, but with links or descriptions of
specific places in the code to get started.

It moves a little of what was in the sysadmin page into this, and
leaves that page as more low-level descriptions of various tasks.

Change-Id: I60a9299df455b98ad549ac0075a59d381722bc06
2022-03-04 12:18:42 +11:00
Ian Wienand
f4209757c2 docs: add note on service-incident list
This is a private list to contact administrators that is suitable for
raising security concerns.

Change-Id: I886f67d875abd09753511f6c33312cfc5eb62933
2021-02-15 06:26:18 +00:00
Andreas Jaeger
62e76b5177 Docs: Update main page for OpenDev
Update conf.py and index.rst for OpenDev.

Use newer openstackdocstheme and update conf.py for this.

Change-Id: I62312ca1d3fda9221660b7bb664c8ea55dac68a4
2020-03-22 19:14:51 +01:00
Andreas Jaeger
2c0b82e5e8 Update infra-manual location
The infra-manual now lives on docs.opendev.org, update links.

New location is: https://docs.opendev.org/opendev/infra-manual/latest

Change-Id: I7716c68cbff4f3a640d7161f59cfc034a7ccca52
2020-03-20 22:03:09 +01:00
Monty Taylor
06353bdb5d Remove running your own doc
This is just so massively out of date fixing it isn't worth it.

Change-Id: Ica122f4579de90c05f4b9327aa04945bbc381daf
2019-04-20 18:25:36 +00:00
Ian Wienand
b99c4c6fb0 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-23 14:49:50 +10:00
Monty Taylor
0625c289c8
Remove infracloud references
We don't run a cloud anymore and don't use these. With the cfg
management update effort, it's unlikely we'd use them in the form they
are in even if we did get more hardware and decide to run a cloud again.

Remove them for clarity.

Change-Id: I88f58fc7f2768ad60c5387eb775a340cac2c822a
2018-08-20 11:03:55 -05:00
Clark Boylan
dae5b29ec4 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-21 13:40:57 -07:00
KATO Tomoyuki
abf838f9bb [doc] Fix incorrect external link markup
Change-Id: I7efe2b697c0045444cc21daaffd0c3eb6cbacadf
2017-05-16 10:16:20 +09:00
Andreas Jaeger
97787e3b3b 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:49:40 +02:00
Andreas Jaeger
e7f4b8396a Remove reference to non-existing page
There is no modindex generated, remove the reference from index file.

Change-Id: I984d3a988d8a8c3b595af6a89fe68af5dcc80cd7
2016-10-29 13:49:17 +02:00
James E. Blair
022be6fffd Add doc on contributing cloud resources
Change-Id: Ic60c6ebffdb2ea0d2df0f08544c40a5f5fb859d8
2015-07-27 16:07:29 -07:00
Clint Byrum
9b95458143 Initial documentation for infra-cloud
This does not include many details, and for good reason. Many of these
things are open questions. I am not sure if we should add a section on
the specific hardware/locations or not, so that is up to date.

The document is written in the present tense, so as we make these things
true, they won't have to be altered. The status section should reflect
how close to reality the documentation is until we implement some of it.

story: 2000175
Change-Id: Icb35adf70fa98e64dbbe0464b95af3b5de51a980
2015-06-24 12:24:58 -07:00
Christian Berendt
d69fa16dae cleaning up index.rst file
Removed notes about the generation of the file.

Change-Id: I53b567ddc0ad09826a976143ee9578e49282caf2
2014-05-28 10:04:13 +02:00
Robert Collins
dd9a25646f 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-25 09:51:17 -08:00
Robert Collins
8e5668d8fd Add missing running-your-own hidden toctree.
Change-Id: If642c7e2c96b3e54b55df5f9bd041a7e30304c04
2013-11-11 09:01:27 +13:00
Elizabeth Krumbach Joseph
d54f659046 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
James E. Blair
dcef558baf Move running-your-own to the sidebar
It is a HOWTO and it isn't part of the flow of the main docs,
which are focused on how the OpenStack project infrastructure
is used and operated.

Change-Id: I6e783899ab55f952acab81c7c90ca596d9bb1603
2013-09-11 13:02:26 -07:00
Robert Collins
01e19830c3 Start documenting running your own CI infra.
This is incomplete, but as I haven't got a full thing up yet I can't
write it all. It is minimally a useful pointer for other folk trying
to do the same thing.

Change-Id: Iefb62a0ff60e5f46f1f0091beef54bfc4a376a53
2013-08-31 07:55:46 +12:00
Doug Hellmann
02b9d7a791 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-12 17:56:41 +00:00
James E. Blair
9ed2be3098 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-30 17:27:07 +00:00
Monty Taylor
74460853d1 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-16 17:30:47 +00:00
Clark Boylan
104c4dfaf5 Add StackForge Documentation.
Add a page for StackForge that includes a blurb about what StackForge is
and is not, and how to add a StackForge project.

Change-Id: I474b626423952018eb23929d395ac038c082cd25
Reviewed-on: https://review.openstack.org/17411
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
2012-12-03 22:54:04 +00:00
Clark Boylan
607b2db8c7 Use Jenkins Job Builder to config ci-docs job.
The existing ci-docs job is a one off job that was configured by hand.
Define the ci-docs job as a Jenkins Job Builder job using the existing
project-docs utilities.

To make the existing utilities work within the puppet repo the doc files
have been moved to doc/source, setup.cfg added to build docs in the new
dir, setup.py builds openstack-ci-puppet (instead of nova), tox now has
a venv virtualenv, and the .gitignore has been updated appropriately.

Change-Id: Ic0f291af181b4ef8eff62c5ec7cf3ccfa5b79800
Reviewed-on: https://review.openstack.org/13729
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-09-27 16:50:32 +00:00