Add docs, releasenotes jobs

Also:
* Use build-openstack-docs-pti job template for docs
* 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.
* Create a release summary note.
* Remove the unused 'true' tox environment.
* Fix doc/build in .gitignore

Change-Id: Ibe9d298bcc76f023c0500038db55d8384f5ff731
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
This commit is contained in:
Dean Troyer 2018-09-05 14:33:42 -05:00
parent f5048fd3c7
commit 88ba4d5f22
4 changed files with 26 additions and 7 deletions

2
.gitignore vendored
View File

@ -7,7 +7,7 @@ centos-mirror-tools/logs/
centos-mirror-tools/output/ centos-mirror-tools/output/
# Sphinx documentation # Sphinx documentation
docs/build/ doc/build/
# Release Notes documentation # Release Notes documentation
releasenotes/build releasenotes/build

View File

@ -1,8 +1,12 @@
--- ---
- project: - project:
templates:
- build-openstack-docs-pti
check: check:
jobs: jobs:
- build-openstack-releasenotes
- openstack-tox-linters - openstack-tox-linters
gate: gate:
jobs: jobs:
- build-openstack-releasenotes
- openstack-tox-linters - openstack-tox-linters

View File

@ -0,0 +1,15 @@
---
prelude: >
These release notes cover the initial release of StarlingX.
The StarlingX Tools project is a new repository of tools used in the
development, build, test and release of StarlingX.
features:
- |
Deployment: Scripts to assist in deploying StarlingX in virtual
environments, supports both QEMU/KVM and VirtualBox.
- |
Mirror Tools: Scripts to build and maintain the mirror required to
complete the StarlingX build process.
- |
Release Tools: Scripts used to automate the steps in producing StarlingX
milestones and releases.

12
tox.ini
View File

@ -35,12 +35,6 @@ commands =
[testenv:venv] [testenv:venv]
commands = {posargs} commands = {posargs}
[testenv:true]
# Use same environment directory as venv to save space and install time
envdir = {toxworkdir}/venv
commands = true
whitelist_externals = true
[testenv:docs] [testenv:docs]
basepython = python3 basepython = python3
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt
@ -56,3 +50,9 @@ commands =
rm -rf releasenotes/build rm -rf releasenotes/build
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
whitelist_externals = rm whitelist_externals = rm
[testenv:newnote]
# Re-use the releasenotes venv
envdir = {toxworkdir}/releasenotes
deps = -r{toxinidir}/doc/requirements.txt
commands = reno new {posargs}