From a620a33f0f916ff5898c57da317313f7956dd2cc Mon Sep 17 00:00:00 2001 From: Ifat Afek Date: Tue, 31 Jan 2017 17:15:39 +0000 Subject: [PATCH] Added release notes to vitrage-dashboard Change-Id: I2164a31c1ccb9047bda69909a2d835e4fdf055e8 --- .../notes/highlight-fc02111debe1e3f5.yaml | 6 ++ .../notes/pin-all-eca759914ddd1429.yaml | 7 ++ ...unburst-enhancements-dd6126beed02ccb4.yaml | 4 + .../notes/template-view-4f10a05c52680f75.yaml | 6 ++ releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 79 +++++++++++++++++++ releasenotes/source/index.rst | 18 +++++ releasenotes/source/unreleased.rst | 5 ++ test-requirements.txt | 1 + tox.ini | 3 + 11 files changed, 129 insertions(+) create mode 100644 releasenotes/notes/highlight-fc02111debe1e3f5.yaml create mode 100644 releasenotes/notes/pin-all-eca759914ddd1429.yaml create mode 100644 releasenotes/notes/sunburst-enhancements-dd6126beed02ccb4.yaml create mode 100644 releasenotes/notes/template-view-4f10a05c52680f75.yaml create mode 100644 releasenotes/source/_static/.placeholder create mode 100644 releasenotes/source/_templates/.placeholder create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst diff --git a/releasenotes/notes/highlight-fc02111debe1e3f5.yaml b/releasenotes/notes/highlight-fc02111debe1e3f5.yaml new file mode 100644 index 0000000..6481fd9 --- /dev/null +++ b/releasenotes/notes/highlight-fc02111debe1e3f5.yaml @@ -0,0 +1,6 @@ +--- +features: + - Added ``highlight`` functionality. When a user selects a vertex in the + Vitrage Entity Graph, the vertex is highlighted together with its + neighbors. It helps the user focus on the relevant area in the graph and + understand the topology. diff --git a/releasenotes/notes/pin-all-eca759914ddd1429.yaml b/releasenotes/notes/pin-all-eca759914ddd1429.yaml new file mode 100644 index 0000000..82ee99e --- /dev/null +++ b/releasenotes/notes/pin-all-eca759914ddd1429.yaml @@ -0,0 +1,7 @@ +--- +features: + - Added ``Pin All`` functionality. In Newton, the user was able to pin an + entity in the Vitrage Entity Graph by double-clicking it. + In Ocata, by clicking the ``Pin All`` button the user can pin all entities, + so their locations will not change if the page is being reloaded or if new + entities are added to the graph. diff --git a/releasenotes/notes/sunburst-enhancements-dd6126beed02ccb4.yaml b/releasenotes/notes/sunburst-enhancements-dd6126beed02ccb4.yaml new file mode 100644 index 0000000..c52ea79 --- /dev/null +++ b/releasenotes/notes/sunburst-enhancements-dd6126beed02ccb4.yaml @@ -0,0 +1,4 @@ +--- +features: + - The ``Vitrage Topology View`` was enhanced. It looks better, visually, + and is much easier to understand. diff --git a/releasenotes/notes/template-view-4f10a05c52680f75.yaml b/releasenotes/notes/template-view-4f10a05c52680f75.yaml new file mode 100644 index 0000000..21d3d3a --- /dev/null +++ b/releasenotes/notes/template-view-4f10a05c52680f75.yaml @@ -0,0 +1,6 @@ +--- +features: + - Added the ``Templates View`` under the Vitrage tab in Horizon. This view + shows a list of the currently loaded templates in Vitrage, with their + statuses. The user can view the contents of each template and understand + the effect it has on the alarms correlation. diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..0e62592 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,79 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', + # 'sphinx.ext.intersphinx', + 'reno.sphinxext', + 'oslosphinx' +] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'vitrage-dashboard releasenotes' +copyright = u'2016, Vitrage developers' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Vitrage-Dashboard ReleaseNotes' % project, + u'Vitrage developers', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +# intersphinx_mapping = {'http://docs.python.org/': None} + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..d674e76 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,18 @@ +================================ + Vitrage-Dashboard Release Notes +================================ + +Contents +======== + +.. toctree:: + :maxdepth: 2 + + unreleased + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..875030f --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/test-requirements.txt b/test-requirements.txt index 21a7e3b..39905a0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,3 +12,4 @@ oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 testscenarios>=0.4 testtools>=1.4.0 +reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 702d2c9..cfed57a 100644 --- a/tox.ini +++ b/tox.ini @@ -33,3 +33,6 @@ show-source = True ignore = E123,E125 builtins = _ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build + +[testenv:releasenotes] +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html