1199 Commits

Author SHA1 Message Date
Michele Baldessari
ce853b2f97 Add some docs for pre_deploy_step_tasks
Via If3c74703a684fbd5a815e073cc9da34e9ad672e8 we're adding a new
set of tasks, let's document those.

Change-Id: I9af03c6de241ad7fe706ee12bdd2a6eece9880a6
Depends-On: If3c74703a684fbd5a815e073cc9da34e9ad672e8
2021-04-02 18:53:24 +02:00
Wes Hayutin
1c32bc558c update the ci reproducer instructions
Change-Id: I1aa9bf19548d2471e533505c57d92490e2864cf1
2021-03-04 13:06:48 -07:00
Carlos Goncalves
e264e81935 Remove references to DefaultPasswords
The DefaultPasswords interface was removed from tripleo-heat-templates
in Change-Id If83d0f3d72a229d737a45b2fd37507dc11a04649.

Change-Id: I42913c36b634ad1fb1c1b4cc0c798fe98dc430c2
2021-02-26 11:26:17 +01:00
Chandan Kumar (raukadah)
2106d94c38 Added documentation for dependency pipeline
Signed-off-by: Chandan Kumar (raukadah) <chkumar@redhat.com>
Change-Id: I8fda2ba2805814d4b00954c5f190e2091024e3e8
2021-02-24 13:26:22 +00:00
John Fulton
bab891464f Avoid sphinxcontrib-mermaid 0.6.1
sphinxcontrib-mermaid 0.6.1 causes issue seen in LP bug
1916280. Newer version of sphinxcontrib-mermaid will fix
so let's avoid problem with known issue.

Change-Id: Iad6b3faa1a4428ce9a59efbc879bcf5a0f394cc1
Closes-Bug: #1916280
2021-02-19 14:54:34 -05:00
Marios Andreou
082b163a93 Add new Component/Integration pipeline docs
This updates the current promotion-stages doc and introduces
the concept of component and integration pipelines.

Change-Id: I77d38d0474a5f7c202e9eb61e5d18f8e59bade86
2021-01-04 11:22:20 +02:00
Alex Schultz
af4b0f229a Add six dep for docs
sphinxcontrib-mermaid is including six but isn't requiring it. Let's add
it here for the pdf support to continue to function.

Change-Id: I53cbfe9f3deb4802aa2e608fa9a0bd66391aac68
2020-12-07 13:13:29 -07:00
MSA
5e7b99a82b Adds docs about the content provider CI jobs
Adds an overview and some details about the new content
provider jobs.

Change-Id: Ieb079303c2644fb7f1bb5e73a0c7972103692cc8
2020-10-21 11:54:15 +00:00
Rajesh Tailor
6447c381b1 Fix typos
This patch tries to fix maximum typos in docs.

Change-Id: Ic406e3a4423cdd7c46c8a4497d43d63c95b2a9f5
2020-08-19 17:20:09 +05:30
Zuul
4dbbd42b86 Merge "Introduce a manual about TripleO core reviewers" 2020-08-18 21:24:15 +00:00
Cédric Jeanneret
64aee82ad8 Rename and update links related to tripleo-ansible roles
During the latest cycles, role names were changed, replacing the hyphen
by underscore.

Change-Id: Ib62963bef59062ac9d81d0cf1f3972a08335af9d
2020-08-12 11:18:06 +02:00
Emilien Macchi
f00729894c Introduce a manual about TripleO core reviewers
For the first time, we now have a manual that describes the expectations
of our core reviewers and hopefully will help people to understand how
they can become core at some point.

Note: this was inspired by https://wiki.openstack.org/wiki/Ironic/CoreTeam
Thanks to the Ironic team for writting this.

Change-Id: I05f8eda29d03adac948159418b0763c5f8b5ddec
2020-07-31 15:38:59 -04:00
Andreas Jaeger
952566d76e Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions 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_version to not auto-version the documents.

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: I6f7b0e00c112f62dd94a907284fcb3698e84479d
2020-05-28 14:42:29 +02:00
Zuul
716a556184 Merge "update list of TripleO core teams" 2020-05-12 12:11:17 +00:00
Wes Hayutin
276f2a4958 update list of TripleO core teams
The TripleO core list has been broken down
into topic specific lists in some cases.
Ensure we have those groups documented

Change-Id: I6dcfefec9fbb0a1b6824b030242a384b1b9eca47
2020-05-06 13:47:50 -06:00
Rabi Mishra
5ce857a4cb Cleanup contributor guide for new developers
Change-Id: Ie4c02f793537cea9ade0d3dc55abbb8300c71513
2020-05-06 10:02:56 +05:30
Rabi Mishra
b01aaf15a3 Remove mistral related developer documentation
Change-Id: I301489c666545418d1e23c58ba75bc30e3db21b9
2020-05-05 08:15:44 +05:30
Andreas Jaeger
9814a1a906 Cleanup py27 support and docs
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Remove unneeded test-requirements.txt file
- Use basepython=python3 for testenv, remove it elsewhere

Change-Id: I2659000c905b3de2f37bd88ab348d2f45e0968cc
2020-04-11 16:32:11 +02:00
Marios Andreou
62a8efc103 Document override tripleo-ci-testing with dlrn_hash_tag testproject
Adds a section into chasing ci promotions doc to explain
how to override the tripleo-ci-testing hash when running
testproject jobs.

Change-Id: If475adc4c2b14d9303e73db58094be16b0c465d0
2020-02-21 17:25:13 +02:00
Zuul
73f9d112b4 Merge "Fix link to UC install guide and mention podman" 2020-01-23 16:27:18 +00:00
Bogdan Dobrelya
7172590e2e Fix link to UC install guide and mention podman
Change-Id: I2298f961431a2abfc6e2eeea903fe95ac560bc02
Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
2020-01-23 12:14:01 +01:00
Zuul
4dea1a330d Merge "Added docs for third party dependency testing" 2020-01-22 16:37:26 +00:00
Chandan Kumar (raukadah)
b5b4846977 Added docs for third party dependency testing
It adds information about:
* TripleO jobs running against ceph-ansible/podman github
  pull requests.
* How to recheck the failed jobs.
* How to file an issue.
* Depends-On usage
* check-rdo vs check-github

https://tree.taiga.io/project/tripleo-ci-board/task/1389

Change-Id: I779b306776d7b629d158368a6182748c7b8c86dc
Signed-off-by: Chandan Kumar (raukadah) <chkumar@redhat.com>
2020-01-22 21:16:07 +05:30
Emilien Macchi
6a3eb65d74 Document the existence of tripleo-container-manage Ansible role
Change-Id: I1f27402364ba1ecdb61b0796d543226ea7205c8f
Depends-On: https://review.opendev.org/703481
2020-01-20 20:44:38 +00:00
Emilien Macchi
ae718ec825 THT: add a link for THT deployment readme
This readme is useful for THT devs, let's make it more visible in
tripleo-docs.

Change-Id: I825e31d499f42ef24179492802e5a052be4195b7
2020-01-07 10:47:27 -05:00
Zuul
3a4534411b Merge "tripleo-ci ruck|rover and promotions docs" 2019-11-08 16:13:25 +00:00
Marios Andreou
508ffb7264 tripleo-ci ruck|rover and promotions docs
Some docs about the promotion process from the ruck|rover
perspective and note about testproject and periodics

Change-Id: I37fe3146d6d5d33dcfa2a09b3d0620f137c7efd5
2019-11-04 17:50:34 +02:00
gujin
b53091fd4b tox: Keeping going with docs
Change-Id: I75ca305e9f5c994f06ccfbfebb1ef53d36e83dfd
2019-11-03 02:37:53 +08:00
Gael Chamoulaud
a24cafef07 Fix tripleo-validations documentation page URL
Change-Id: I5291c3ad292642c226945173aad47fb59917415f
Signed-off-by: Gael Chamoulaud <gchamoul@redhat.com>
2019-09-23 14:06:11 +02:00
Zuul
a4e97cd9c7 Merge "PDF documentation build" 2019-09-19 14:02:19 +00:00
Zuul
0f9a318459 Merge "Adding upgrade with os upgrade graphics." 2019-09-19 11:03:31 +00:00
Bogdan Dobrelya
f313d7a87f PDF documentation build
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

The list of changes:
- copy the docs testenvs' dependencies from
  Ib3bb34191582f581c28f2f8a0281cf3ae44003e8
- do not place unrelated to the docs testenvs entries for the
  test-requieremets.txt, add missing flake8
- add the missing sphinxcontrib-mermaid docs requirements
- render mermaid diagrams only for html builds, for PDF use a hand-made
  quick and dirty approximation instead (if used for PDF builds, it
  fails on the py3 deprecated warn() methos)
- add the project architecture and components into the main ToC, omit
  rendering additional contents pages for PDF builds
- add a new pdf-docs environment to enable PDF build,
- sphinxcontrib-svg2pdfconverter is used to handle SVG properly,
- Add requirements for sphinx and poke it for openstackdocstheme,
- disable usage of xindy for tex,
- do not generate empty pages,

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

TeX and  few more packages may be needed to build PDF locally
(listed for bindep):

inkscape [doc platform:dpkg]
fonts-liberation [doc platform:dpkg]
texlive-latex-base [doc platform:dpkg]
texlive-latex-extra [doc platform:dpkg]
texlive-xetex [doc platform:dpkg]
texlive-fonts-recommended [doc platform:dpkg]
xindy [doc platform:dpkg]
latexmk [doc platform:dpkg]
texlive [doc platform:rpm]
texlive-fncychap [doc platform:rpm]
texlive-titlesec [doc platform:rpm]
texlive-tabulary [doc platform:rpm]
texlive-framed [doc platform:rpm]
texlive-wrapfig [doc platform:rpm]
texlive-upquote [doc platform:rpm]
texlive-capt-of [doc platform:rpm]
texlive-needspace [doc platform:rpm]
texlive-polyglossia [doc platform:rpm]
latexmk [doc platform:rpm]
python3-sphinxcontrib-svg2pdfconverter-common [doc platform:rpm]
librsvg2-tools [doc platform:rpm]
librsvg2-bin [doc platform:dpkg]

Change-Id: Ib3bb34191582f581c28f2f8a0281cf3ae44003e8
Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
2019-09-17 17:20:48 +02:00
Sorin Sbarnea
98ef15b0f7 Fix trunk.rdoproject.org url
trunk-primary hostname should never be used in jobs as it does not
have a valid certificated.

Change-Id: I736410f80ab15dc492f9462ddb9fefcdb86f3f00
2019-09-03 12:04:05 +01:00
Zuul
07fa87f28e Merge "Update references to deploy-guide" 2019-08-23 14:21:47 +00:00
Zuul
a455fbebc7 Merge "Add tempest_private_net_provider_type to allowed_overrides" 2019-08-22 20:14:12 +00:00
Alex Schultz
24c60ef633 Update references to deploy-guide
Since we moved the installation items to the deploy-guide, we need to
make sure we properly reference the new locations.

Change-Id: Ic481bf333b868d32638e5970b18c367f9d23d45c
2019-08-22 09:23:30 -06:00
Alex Schultz
c6918e5da6 Migrate install to deploy-guide
The deployment guide is currently pointed at triplo-docs but it has been
requested that we actually publish a deployment guide. This change
extracts many of the installation doc pages and moves them into the
deploy-guide source tree.  Once the deploy-guide is published, we will
follow up to reference the deployment guide from tripleo-docs.

Change-Id: I0ebd26f014180a92c6cf4ab0929d99b2d860796f
2019-08-16 15:42:17 -06:00
Alex Schultz
cd139d47d8 Deprecate UI install instructions
Tripleo-ui has been removed as of Train. But we should keep the docs
around a bit longer as we don't branch tripleo-docs.

Change-Id: Iaaa3f6ece433401d696fe7f5d29d916c5c3d0c26
2019-08-16 14:55:20 -06:00
Zuul
501037e2c0 Merge "Document minor update of DCN deployment" 2019-08-16 15:25:42 +00:00
Zuul
57abe2d6f2 Merge "Fix mispelling on include/exclude list" 2019-08-14 22:37:15 +00:00
Trevor Vardeman
23889cf575 Updating the numbers for undercloud installation documentation
Changed a repositories document from txt to rst to properly render the rst
syntax within, and updated all references to that document.  Also updated the
installation document to properly process the auto configured numbering.

Change-Id: I7fad6e5f89023575c86fef70f2ee17c1543c546d
Closes-Bug: 1827829
2019-08-14 10:21:52 -05:00
fpantano
ccdc0fb1e4
Fix mispelling on include/exclude list
Change-Id: I097a22af29464ee39b49f44dd0aa3548ce015605
2019-08-14 16:36:44 +02:00
Zuul
7642dadb62 Merge "Minion doc" 2019-08-12 15:15:25 +00:00
Zuul
cdff1e5344 Merge "Override multiple ceph.conf sections using CephConfigOverrides" 2019-08-08 06:47:13 +00:00
Zuul
341eb0e10c Merge "Include SSH key in manual config-download Ceph example" 2019-08-06 19:55:00 +00:00
Marios Andreou
642e890a72 Add tempest_private_net_provider_type to allowed_overrides
We add tempest_private_net_provider_type as a featureset_override
in depends-on for scenario7 (ovs) standalone. This adds it to the doc
and updates the outdated link to the allowed overrides.

Depends-On: https://review.opendev.org/674228

Change-Id: I0a80c76bffafa4596888c86753915dd99f538a80
2019-08-06 15:26:19 +00:00
fpantano
341b993660
Override multiple ceph.conf sections using CephConfigOverrides
With the latest ceph-base change we now have the ability to
override the variables in multiple sections of ceph.conf other
than global.
This change improves the existing example of CephConfigOverrides
definition with an additional parameter in the [osd] section.

Depends-On: https://review.opendev.org/#/c/658161
Change-Id: I9d5cf96622b895cd0dad83b6fd3e41ed7204d50e
2019-08-06 08:27:21 +02:00
Zuul
43662ae092 Merge "Document using AllNodesExtraMapData from config-download" 2019-08-06 00:02:46 +00:00
Zuul
7dbf3c7c32 Merge "Fix some links" 2019-08-06 00:02:45 +00:00
Alex Schultz
70bf883213 Minion doc
Document the basic install for the undercloud minion

Related-Blueprint: undercloud-minion
Change-Id: Idbcd60c89ed3e078c4ee41743e4d9955bae2e86d
2019-08-05 13:35:05 -06:00