diff options
| author |   Gregory Glover <gg2147@att.com> | 2017-11-17 13:59:08 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2017-11-17 13:59:08 +0000 |
| commit | b57b15c83fe31d7663478dd2e8143d1e73e9700a (patch) | |
| tree | e793dba272e77d98b5beff456f23529b756068ef /docs/guides | |
| parent | 6f6b81d7513cd57bf1ac4532854194202ba0b625 (diff) | |
| parent | b921b99f27d55e46db2b72b5987ffacb1f781857 (diff) | |
Merge "Improve References to User Guides"
Diffstat (limited to 'docs/guides')
10 files changed, 26 insertions, 6 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index b14acc170..db4cd6a51 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,6 +2,8 @@ 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 diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 960cda23b..d4f38d9cf 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -3,6 +3,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Platform Architecture + .. _doc-architecture: Architecture diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index c5690ac2a..c6528f12c 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -2,6 +2,8 @@ .. 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 diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index eccd0022a..2d8a25cfa 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the This line will be shown only in html version. -.. index:: single: indices - Creating Indices ---------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 8fd9a730b..9c5822d2b 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is integrated for each release. Other ONAP projects will provide content that is referenced from this structure. -.. index:: master :: @@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by RST file changes in the top level docs directory and below. -.. index:: licensing Licensing --------- diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index a73ae6fb3..6f1dd2d33 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,3 +12,8 @@ Creating Documentation include-documentation converting-formats addendum + +.. toctree:: + :hidden: + + update-review.rst diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst index 859005f55..6d3d891da 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -7,6 +7,8 @@ :depth: 2 .. +.. index:: Setting Up Full ONAP + ======================== **Setting Up Full ONAP** diff --git a/docs/guides/onap-user/platformadmin.rst b/docs/guides/onap-user/platformadmin.rst index 1c573f42b..4ebc72ba7 100644 --- a/docs/guides/onap-user/platformadmin.rst +++ b/docs/guides/onap-user/platformadmin.rst @@ -1,5 +1,11 @@ .. 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 ====================== -* `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>`_ + diff --git a/docs/guides/onap-user/serviceadmin.rst b/docs/guides/onap-user/serviceadmin.rst index 97db4260a..40bdf01ee 100644 --- a/docs/guides/onap-user/serviceadmin.rst +++ b/docs/guides/onap-user/serviceadmin.rst @@ -2,6 +2,9 @@ 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>`_ diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst index 0ae7f35fd..c934c3a04 100644 --- a/docs/guides/onap-user/servicedesigner.rst +++ b/docs/guides/onap-user/servicedesigner.rst @@ -2,5 +2,7 @@ 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>`_ |