diff options
author | 2017-02-07 13:23:37 -0600 | |
---|---|---|
committer | 2017-02-07 13:23:37 -0600 | |
commit | 572ce78c886cf49bd617a2ff3d96491b22a66f88 (patch) | |
tree | d32e4c9d727ece871ec89f1d47005756ddc2b3c7 /docs/release/userguide | |
parent | c04ffff59b770ae32c4691bdc3d3b4363604db78 (diff) |
Updated to use new docs structure WIP
JIRA: COPPER-1
WIP - not sure how to fill in the docs/release/scenarios section
Change-Id: I8684e4647e7b943ca05dc77131a54338ff932b78
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Diffstat (limited to 'docs/release/userguide')
-rw-r--r-- | docs/release/userguide/feature.userguide.rst | 20 | ||||
-rw-r--r-- | docs/release/userguide/index.rst | 24 |
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..c43a502 --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV Copper User Guide +======================= + +.. contents:: + :depth: 3 + :local: + +This release focuses on use of the OpenStack Congress service for managing +configuration policy. See the Congress `intro guide <http://docs.openstack.org/developer/congress/index.html>`_ +for general information on the capabilities and usage of Congress. + +Examples of Congress API usage can be found in the Copper tests as described +on the OPNFV wiki at https://wiki.opnfv.org/display/copper/testing. + diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..1004c3e --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV Copper User Guide +======================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + |