8 Commits

Author SHA1 Message Date
Zuul
6e27d402d3 Merge "Clean up and standardize landing pages" 2019-02-27 14:47:58 +00:00
Kristal Dale
626f1094ad Clean up and standardize landing pages
doc index.rst:
1. Update intro sentence to read as a complete sentence
2. Remove unused toctree
3. Correct heading levels (impacting side nav and correct rendering
of content)
4. Remove "Indices and Tables" section: genindex page not used,
search searches only index (not useful here)

releasenotes index.rst:
1. Remove search (make consistent with other openstack release note
pages)

Story: 2004737
Task: 29273

Change-Id: Iff659b42ab14ef5726869d9c9aa69b7c58a756fd
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-02-27 14:22:45 +00:00
Kristal Dale
e6503af8c2 Update config for release notes to include project name
Update conf.py for release notes to include the project
variable, set to the project name. This is so the string
above the left nav renders the project name.

Story: 2004900
Task: 29232

Change-Id: I2c60b94b61884a1f366b57d197b69dcee38761ef
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-02-05 13:56:16 -08:00
Abraham Arce
5a021f1584 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Add zuul check and gate job:

- build-openstack-api-ref

Change-Id: I0d59eaf777bb0f462db4d436c030a785e61798d2
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:38:52 +00:00
Dean Troyer
286deaf2aa Add api-ref and relnotes publish jobs
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref and publish-stx-releasenotes jobs
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
* Change the default themes to alabaster

Change-Id: Ied2bb5738cb04c539995850810064b03ca937862
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-15 10:36:09 -05:00
Dean Troyer
e489326a40 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I5cc9b7203c5a28057783315da100b3caabf67e19
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:42:40 -05:00
Dean Troyer
292c70a8bf [Doc] stx.2018.10 Release Summary
Create stx.2018.10 release summary note

Change-Id: Ic014cd96dcdbb4199a4f736f39b95d6ffdf70725
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-28 14:10:43 +00:00
Abraham Arce
57e9e71cb6 [Doc] Release Notes Management
Baseline changes to comply with Release Notes Management
based in Reno [0]:

* Use build-openstack-releasenotes job for release notes
  (We can't use the OpenStack releasenotes template as it includes
  publish jobs, stx needs its own)
* Add newnote tox environment as convenience for creating new release
  notes, re-using the releasenotes venv.
* Remove the unused 'true' tox environment.

[0] https://docs.openstack.org/reno/latest/

Story: 2003101
Task: 26658

Change-Id: I0bce008d3c26859ba7ca72aeec664ed417e22ea1
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 15:01:30 -07:00