- Landing page:
- General clean up (org of page, improve wording, markdown clean up)
- Replace Abstract with welcome text, move link to project spec to welcome.
- Include ref to contribute guide in Contribute section
- Remove "Contents" caption from toctree (so it wont render in side nav)
- Release notes page:
- Remove "StarlingX" from page title.
- Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes
- Improve wording, link text
- API ref page: Update page title to "REST API Reference"
- All pages:
- Capitalization corrections
- Clean up section heading markdown for consistency
- libvert installation page:
- corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy)
Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Updated three "index.html" files to remove the "Software Updates"
link from two API ref landing pages and one general StarlingX
doc landing page. The link appeared in three areas:
The "Software Updates" page no longer exists.
Change-Id: Ib54057ad840b2fd0029ef5da03addaf621d0c731
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Installation guides should list the XML server definitions for each
configuration:
- Controller-N
- Compute-N
- Storage-N
Additionally, where it applies:
- Add method to power up virtual servers.
- Reword system configuration section.
- Use host-if-modify syntax valid for current release.
Minor changes:
- Remove DRAFT from the top of Release Notes Contribute Guide.
- Fix api-ref broken links
Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
We want that in the nav sidebar, use a full URL because that
subtree comes from stx-specs with its own index.rst.
Change-Id: I8a6cda4071405a40b4a3385c80e99579c1b370e1
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).
Also add docs env to the default list in tox.ini.
Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
1. Updated index page to include toctree for proposed organization of docs. Updated sample content (this needs to be finalized - SAMPLE content only).
2. Added Installation Guide page. Migrated content from wiki to docs (reST).
3. Added Developer Guide page. Migrated content from wiki to docs (reST).
4. Updated Contribute page to link to 2 child pages
- Added API Contributor Guide page. Migrated content from wiki to docs (reST).
- Added Release Notes Contributor Guide page. Added draft content from etherpad (reST).
5. Removed trailing white space in files (patch)
Depends-On: https://review.openstack.org/#/c/611078
Change-Id: If4448fcc096f8fdcdf0d88c31b6b42ea94aea1fd
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref job
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
* Add openstackdocstheme installation into requirements file
Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
We have the AFS volume and now a publish job, let's see if we
can get from here to there. Include a docs change to ensure
the jobs actually run.
the web server is near, pending certificate installation.
Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
* Use build-openstack-docs-pti for the main docs job rather than
the old legacy build-openstack-sphinx-docs-python3
* Use build-openstack-api-ref for the api-ref job (we can not
use OpenStack's api-ref-jobs template as it includes their
publisih jobs)
Change-Id: I646090e4dcc3260b3d963434a228bd5ef3a919fc
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
I added the api-ref-blockstorage-v2-cgcs-ext.rst,
api-ref-compute-v2-cgcs-ext.rst, api-ref-image-v2-cgcs-ext.rst,
and api-ref-networking-v2-cgcs-ext.rst files, which are content
for the remaining 4 API reference manuals to the api-ref/source
dir. This represents the converted old-style files to the newer
OpenStack supported RST files.
I updated the index.rst file to include the new .rst file so that
the api-ref document can build.
Change-Id: I4c3e89d38b1e6afd52d0307fb95be8c0d974ff45
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0] for
the following StarlingX staging repos:
- stx-python-cinderclient
- stx-nova
- stx-glance
- stx-neutron
Changes:
- [1] How to document your OpenStack API service
- Adding SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html
Story: 2002712
Task: 26728
Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Start with building Sphinx, include links to the anticipated locations
for /releasenotes and /specs.
Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
[dtroyer: fixed linters job and added to gate queue so this can be merged]
Story: 2002813
Task: 22727
Change-Id: I8a988cc49440b21176dc95bd12ad383836148dca
Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
