Insert Note before DW User Guide Links
Add index entries to for major sections topics
Remove requirement.txt workarounds after RTD change to
recognize readthedocs.yml in the root folder
Update release notes
Change-Id: Id57ff10a055ea1d1e5394170d5b5b401d51d58ab
Issue-ID: DOC-60
Signed-off-by: Rich Bennett <rb2745@att.com>
15 files changed:
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: API Reference
+
.. _doc-apiref:
REST API Reference
.. _doc-apiref:
REST API Reference
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Platform Architecture
+
.. _doc-architecture:
Architecture
.. _doc-architecture:
Architecture
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Developer Guides
+
.. _doc_onap-developer_guide_projects:
Developing ONAP
.. _doc_onap-developer_guide_projects:
Developing ONAP
This line will be shown only in html version.
This line will be shown only in html version.
-.. index:: single: indices
-
Creating Indices
----------------
Creating Indices
----------------
integrated for each release. Other ONAP projects will provide
content that is referenced from this structure.
integrated for each release. Other ONAP projects will provide
content that is referenced from this structure.
RST file changes in the top level docs directory and below.
RST file changes in the top level docs directory and below.
include-documentation
converting-formats
addendum
include-documentation
converting-formats
addendum
+
+.. toctree::
+ :hidden:
+
+ update-review.rst
+.. index:: Setting Up Full ONAP
+
========================
**Setting Up Full ONAP**
========================
**Setting Up Full ONAP**
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
Platform Administrator
======================
Platform Administrator
======================
-* `See Platform Administrator <https://wiki.onap.org/x/fIsP>`_
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the link below.
+
+* `ONAP Portal <https://wiki.onap.org/x/fIsP>`_
+
Service Administrator
=====================
Service Administrator
=====================
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the links below.
+
* `Deploy <https://wiki.onap.org/x/CowP>`_
* `Operate <https://wiki.onap.org/x/TYwP>`_
* `Deploy <https://wiki.onap.org/x/CowP>`_
* `Operate <https://wiki.onap.org/x/TYwP>`_
Service Designer
================
Service Designer
================
+.. note::
+ Until this section is migrated to gerrit/readthedocs, use the link below.
-* `See Service Designer <https://wiki.onap.org/x/E4AP>`_
+* `Service Designer <https://wiki.onap.org/x/E4AP>`_
-:Release Date: yyyy-mm-dd
+:Release Date: 2017-11-20
-Release controlled documentation moved to / now managed in gerrit and published
+Project release controlled documentation is now managed in gerrit and published
on readthedocs.
**Bug Fixes**
on readthedocs.
**Bug Fixes**
-The developer wiki still contains pages that are release dependent, should be
-under change control in gerrit, and are being referenced from some gerrit change controlled documentation. The pages and links that remain to be migrated
-are listed in <JIRA ISSUE> and by TBD tag or other indicator on the wiki.
+The developer wiki still contains some pages that are referenced from the
+readthedocs documentation. The pages and links that remain to be migrated
+are listed in Jira Issue DOC-179 and labeled on the wiki with "move-to-rtd".
.. This work is licensed under a Creative Commons Attribution 4.0
International License. http://creativecommons.org/licenses/by/4.0
.. This work is licensed under a Creative Commons Attribution 4.0
International License. http://creativecommons.org/licenses/by/4.0
+.. index:: Release Notes
+
Releases
========
This page is the ONAP Amsterdam Release Notes. The first release is
Releases
========
This page is the ONAP Amsterdam Release Notes. The first release is
Functionality
+++++++++++++
Functionality
+++++++++++++
-*Portal* - a single, consistent user experience for both design timer
+**Portal** - a single, consistent user experience for both design timer
and run time environments, based on the user’s role.
and run time environments, based on the user’s role.
-*Design Time Framework* - a comprehensive development environment with
+**Design Time Framework** - a comprehensive development environment with
tools, techniques, and repositories for defining/describing resources,
services, and products:
tools, techniques, and repositories for defining/describing resources,
services, and products:
and/or enforced.
- Closed Loop Automation Management Platform (CLAMP) provides a method
and/or enforced.
- Closed Loop Automation Management Platform (CLAMP) provides a method
- for designing and managing control loops.**
+ for designing and managing control loops.
-*Runtime Framework* - The runtime execution framework executes the
+**Runtime Framework** - The runtime execution framework executes the
rules and policies distributed by the design and creation environment
and Controllers that manage resources corresponding to their assigned
controlled domain:
rules and policies distributed by the design and creation environment
and Controllers that manage resources corresponding to their assigned
controlled domain:
system’s resources, services, products and their relationships with each
other.
system’s resources, services, products and their relationships with each
other.
-*Closed-Loop Automation* -- Design -> Create -> Collect -> Analyze >
+**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
Detect -> Publish -> Respond:
- Data Collection, Analytics and Events (DCAE) collects performance,
Detect -> Publish -> Respond:
- Data Collection, Analytics and Events (DCAE) collects performance,
Refer to :ref:`release notes <doc-releaserepos>` for each project.
Refer to :ref:`release notes <doc-releaserepos>` for each project.
+
+.. index:: Licensing
+
Licenses
++++++++
ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
Licenses
++++++++
ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_.
+.. index:: Reporting Bugs
+
How to Report a Bug
+++++++++++++++++++
There are 2 ways to report a bug in ONAP.
How to Report a Bug
+++++++++++++++++++
There are 2 ways to report a bug in ONAP.
You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap .
+.. index:: Installation
+
+
Install
+++++++
There are 2 approaches to install ONAP.
Install
+++++++
There are 2 approaches to install ONAP.
the vFirewall sanity use case is documented
in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
the vFirewall sanity use case is documented
in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
+
+.. Include files referenced by link in the toctree as hidden
+
+.. toctree::
+ :hidden:
+
+ release-manifest.rst
+ releaserepos.rst
+ repolist.rst
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
International License. http://creativecommons.org/licenses/by/4.0
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Release Manifest
+
.. _doc-release-manifest:
Release Manifest
.. _doc-release-manifest:
Release Manifest
Copyright 2017 AT&T Intellectual Property. All rights reserved.
Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. index:: Projects Providing Documentation
+
.. _doc-repolist:
Project/Components
.. _doc-repolist:
Project/Components
+++ /dev/null
-tox
-Sphinx==1.5.3
-doc8
-docutils
-setuptools
-six
-sphinx_rtd_theme
-sphinxcontrib-blockdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-sphinx_bootstrap_theme>=0.4.11