From be2f13684e057e4e92ef1e3f7e1efea2b68585d5 Mon Sep 17 00:00:00 2001
From: Omer Anson <omer.anson@toganetworks.com>
Date: Mon, 6 Nov 2017 22:58:39 +0200
Subject: [PATCH] Add documentation: Creating release notes with reno

Change-Id: Idb5dad09e7ef5ae8c9eda0a7a862f16cf0b8d2e4
---
 doc/source/index.rst               |  1 +
 doc/source/releasenotes_create.rst | 40 ++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 doc/source/releasenotes_create.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3a7912f64..a8f2fd342 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -26,6 +26,7 @@ Contents:
    features
    manual_deployment
    contributing
+   releasenotes_create
    releasenotes
 
 Dragonflow Specs
diff --git a/doc/source/releasenotes_create.rst b/doc/source/releasenotes_create.rst
new file mode 100644
index 000000000..23ff745ef
--- /dev/null
+++ b/doc/source/releasenotes_create.rst
@@ -0,0 +1,40 @@
+================================
+Creating release notes with Reno
+================================
+
+Release notes for Dragonflow are generated semi-automatically from source with
+Reno.
+
+Reno allows you to add a release note. It creates a yaml structure for you to
+fill in. The items are explained `here <https://docs.openstack.org/reno/latest/user/usage.html#editing-a-release-note>`_. If an item is not needed, it can be
+removed from the structure.
+
+Basic Usage
+-----------
+
+To create a new release note, run:
+
+::
+
+    tox -e venv -- reno new <my-new-feature>
+
+This creates a release notes file. You can identify the file with the output:
+
+::
+
+    Created new notes file in releasenotes/notes/asdf-1a11d0cca0cb76fa.yaml
+
+You can now edit this file to fit your release notes needs.
+
+Don't forget to add this file to the commit with `git add`.
+
+The release notes are built automatically by the gate system. There is a tox
+environment to generate all the release notes manually. To do so, run:
+
+::
+
+    tox -e releasenotes
+
+Easy enough!
+
+For more information, see the `reno usage documentation <https://docs.openstack.org/reno/latest/user/usage.html>`_.