17 Commits

Author SHA1 Message Date
Piotr Parczewski
5db72659a0 [docs] Unify project's naming convention
There are inconsitencies across the documentation and the source code files
when it comes to project's name (Kolla Ansible vs. Kolla-Ansible). This
commit aims at unifying it so that the naming becomes consistent everywhere.

Change-Id: I903b2e08f5458b1a1abc4af3abefe20b66c23a54
2021-01-27 20:08:41 +01:00
likui
341a6ed08e remove unicode from code
Change-Id: Id9110a1f536377cea0386dda6814035d73de13b1
Implements: blueprint remove-unicode
2021-01-23 17:17:50 +08:00
Zuul
045c2f1565 Merge "docs: add info on adding and removing hosts" 2020-12-29 16:09:32 +00:00
Zuul
edb3bce7c5 Merge "docs: Add magnum guide" 2020-12-16 09:37:23 +00:00
Zuul
8e765f8007 Merge "docs: add scaffolding for redirects" 2020-11-24 15:52:13 +00:00
Mark Goddard
9c8dd7240d docs: Add magnum guide
Currently just covers deployment of Magnum. Usage information may be
added in future.

Change-Id: I3c1594c73be8e6805f80d51aad2343c084650bc2
2020-11-23 13:51:31 +00:00
Mark Goddard
03b81174cb docs: add info on adding and removing hosts
Forward-ported from Train commit
I19c7f05b538a7abc9253194bf041c037b1998378.

Change-Id: If07b84e0bbdcb7da8dbef87cc8826987f1d11cf8
2020-10-14 11:48:40 +01:00
Mark Goddard
1f71b5f0d9 docs: add scaffolding for redirects
This allows us to move pages around without breaking links.

Change-Id: Id2be1e6aba9fba376cf217b558ca922d8db1da28
2020-09-17 17:47:55 +01:00
Mark Goddard
761ea9a333 Support TLS encryption of RabbitMQ client-server traffic
This change adds support for encryption of communication between
OpenStack services and RabbitMQ. Server certificates are supported, but
currently client certificates are not.

The kolla-ansible certificates command has been updated to support
generating certificates for RabbitMQ for development and testing.

RabbitMQ TLS is enabled in the all-in-one source CI jobs, or when
The Zuul 'tls_enabled' variable is true.

Change-Id: I4f1d04150fb2b5af085b762890092f87ae6076b5
Implements: blueprint message-queue-ssl-support
2020-09-17 12:05:44 +01:00
Mark Goddard
543eb4bdfd octavia: Add documentation
Covers manual registration of resources.

Change-Id: Idbee6ea1dba911cda38a0df307ed94e4ef98900d
Closes-Bug: #1877417
2020-06-22 09:14:22 +00:00
jacky06
c4cee86581 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

Update Sphinx version as well.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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.

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.

Set openstackdocs_auto_name to use 'project' as name.

Co-Authored-By: Andreas Jaeger <aj@suse.com>
Change-Id: If23546ac4cc2c19626e05b460651b61d5e82d948
2020-06-06 15:29:04 +02:00
Radosław Piliszek
96a5730a42 Fix pygments style
New theme of docs (Victoria+) respects pygments_style.
Since Kolla starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.
Thanks @AJaeger for suggestion.

Change-Id: Iaf3c70b24685ab962f29007deec10b9d53c663bc
2020-05-19 20:08:46 +02:00
Radosław Piliszek
a7f88f2d81 Docs: show other versions
Change-Id: Ib92607d5b5804e6fb166d9c2b20a803e130cb268
2020-02-07 18:55:35 +01:00
Mark Goddard
ef3abc455f Build pdf doc
The is one of community goals that each project should produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is
recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

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

Change-Id: Ia0f8b73bcbda6295319f5c8de1aa02a40844207b
2019-09-17 14:14:18 +01:00
chenxing
31526d4c26 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I118e4d211617c5df66ff04dc04e308a1d2fc67ad
2019-06-17 23:00:42 +08:00
chenxing
a02de6732e Fix the deploy guide build failed
Depends-On: https://review.opendev.org/662209
Co-authored-by: Stephen Finucane <stephenfin@redhat.com>
Closes-Bug: #1830586
Change-Id: I48d3f4c5f7c04b1ab41b3bad2a6c19e1e9a218fd
2019-06-04 17:06:31 +08:00
chenxing
cbd67ebdb1 Rearrange existing documentation to fit the new standard layout
For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Co-Authored-By: Eduardo Gonzalez <dabarren@gmail.com>
Change-Id: I3a7c0ed204ee1e9060b5325f20622afe9a5e3040
2017-09-06 17:43:56 +02:00