From 88ba4d5f229ab21bcf883f4e2792a0cc8c740455 Mon Sep 17 00:00:00 2001
From: Dean Troyer <dtroyer@gmail.com>
Date: Wed, 5 Sep 2018 14:33:42 -0500
Subject: [PATCH] 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>
---
 .gitignore                                        |  2 +-
 .zuul.yaml                                        |  4 ++++
 .../notes/release-summary-9c35dd1bd9b020f1.yaml   | 15 +++++++++++++++
 tox.ini                                           | 12 ++++++------
 4 files changed, 26 insertions(+), 7 deletions(-)
 create mode 100644 releasenotes/notes/release-summary-9c35dd1bd9b020f1.yaml

diff --git a/.gitignore b/.gitignore
index acb93792..cad81b6e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,7 +7,7 @@ centos-mirror-tools/logs/
 centos-mirror-tools/output/
 
 # Sphinx documentation
-docs/build/
+doc/build/
 
 # Release Notes documentation
 releasenotes/build
diff --git a/.zuul.yaml b/.zuul.yaml
index 7ccbd0a6..6c524d97 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,8 +1,12 @@
 ---
 - project:
+    templates:
+      - build-openstack-docs-pti
     check:
       jobs:
+        - build-openstack-releasenotes
         - openstack-tox-linters
     gate:
       jobs:
+        - build-openstack-releasenotes
         - openstack-tox-linters
diff --git a/releasenotes/notes/release-summary-9c35dd1bd9b020f1.yaml b/releasenotes/notes/release-summary-9c35dd1bd9b020f1.yaml
new file mode 100644
index 00000000..8b4abd40
--- /dev/null
+++ b/releasenotes/notes/release-summary-9c35dd1bd9b020f1.yaml
@@ -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.
diff --git a/tox.ini b/tox.ini
index 47d8c1b6..963d5ee2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -35,12 +35,6 @@ commands =
 [testenv:venv]
 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]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
@@ -56,3 +50,9 @@ commands =
     rm -rf releasenotes/build
     sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 whitelist_externals = rm
+
+[testenv:newnote]
+# Re-use the releasenotes venv
+envdir = {toxworkdir}/releasenotes
+deps = -r{toxinidir}/doc/requirements.txt
+commands = reno new {posargs}