Correct broken links 75/115475/1
authorEric Debeau <eric.debeau@orange.com>
Thu, 26 Nov 2020 16:02:40 +0000 (17:02 +0100)
committerEric Debeau <eric.debeau@orange.com>
Thu, 26 Nov 2020 16:02:40 +0000 (17:02 +0100)
Correct broken links detected by sphinx linkcheck
Correct Doc8 warnings
Add License headers

Issue-ID: DOC-690
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I89b4b76206f7c4c6ba580fc9191ea838b43e13eb

docs/guides/onap-developer/how-to-use-docs/converting-to-rst.rst
docs/guides/onap-operator/onap-portal-admin/onap-portal-admin.rst
docs/guides/onap-user/onap-portal-user/onap-portal-user.rst

index 56449be..edbf1e2 100644 (file)
@@ -7,8 +7,8 @@
 Converting to RST
 =================
 
-RST format is used for documentation. Other file formats can be converted to RST
-with pandoc.
+RST format is used for documentation. Other file formats can be converted to
+RST with pandoc.
 
 .. caution::
 
@@ -40,53 +40,53 @@ you'd like to convert:
 
 :code:`-f` tells pandoc the input format. It should be one of the following:
 
-+--------------------+---------------------------------------------------------------+
-| Format             | Description                                                   |
-+====================+===============================================================+
-|commonmark          | Markdown variant                                              |
-+--------------------+---------------------------------------------------------------+
-|docbook             | XML-based markup                                              |
-+--------------------+---------------------------------------------------------------+
-|docx                | Microsoft Word                                                |
-+--------------------+---------------------------------------------------------------+
-|epub                | Ebook format                                                  |
-+--------------------+---------------------------------------------------------------+
-|haddock             | Doc format produced by tool used on Haskell code              |
-+--------------------+---------------------------------------------------------------+
-|html                | HTML                                                          |
-+--------------------+---------------------------------------------------------------+
-|json                | JSON pandoc AST                                               |
-+--------------------+---------------------------------------------------------------+
-|latex               | Older typesetting syntax                                      |
-+--------------------+---------------------------------------------------------------+
-|markdown            | Simple formatting syntax meant to produce HTML                |
-+--------------------+---------------------------------------------------------------+
-|markdown_github     | Github flavored markdown                                      |
-+--------------------+---------------------------------------------------------------+
-|markdown_mmd        | Multi-markdown flavored markdown                              |
-+--------------------+---------------------------------------------------------------+
-|markdown_phpextra   | PHP flavored markdown                                         |
-+--------------------+---------------------------------------------------------------+
-|markdown_strict     | Markdown with no added pandoc features                        |
-+--------------------+---------------------------------------------------------------+
-|mediawiki           | Popular wiki language                                         |
-+--------------------+---------------------------------------------------------------+
-|native              | Pandoc native Haskell                                         |
-+--------------------+---------------------------------------------------------------+
-|odt                 | Open document text (used by LibreOffice)                      |
-+--------------------+---------------------------------------------------------------+
-|opml                | Outline processor markup language                             |
-+--------------------+---------------------------------------------------------------+
-|org                 | Org mode for Emacs                                            |
-+--------------------+---------------------------------------------------------------+
-|rst                 | reStructuredText                                              |
-+--------------------+---------------------------------------------------------------+
-|t2t                 | Wiki-like formatting syntax                                   |
-+--------------------+---------------------------------------------------------------+
-|textile             | A formatting syntax similar to RST and markdown               |
-+--------------------+---------------------------------------------------------------+
-|twiki               | Popular wiki formatting syntax                                |
-+--------------------+---------------------------------------------------------------+
++--------------------+----------------------------------------------------+
+| Format             | Description                                        |
++====================+====================================================+
+|commonmark          | Markdown variant                                   |
++--------------------+----------------------------------------------------+
+|docbook             | XML-based markup                                   |
++--------------------+----------------------------------------------------+
+|docx                | Microsoft Word                                     |
++--------------------+----------------------------------------------------+
+|epub                | Ebook format                                       |
++--------------------+----------------------------------------------------+
+|haddock             | Doc format produced by tool used on Haskell code   |
++--------------------+----------------------------------------------------+
+|html                | HTML                                               |
++--------------------+----------------------------------------------------+
+|json                | JSON pandoc AST                                    |
++--------------------+----------------------------------------------------+
+|latex               | Older typesetting syntax                           |
++--------------------+----------------------------------------------------+
+|markdown            | Simple formatting syntax meant to produce HTML     |
++--------------------+----------------------------------------------------+
+|markdown_github     | Github flavored markdown                           |
++--------------------+----------------------------------------------------+
+|markdown_mmd        | Multi-markdown flavored markdown                   |
++--------------------+----------------------------------------------------+
+|markdown_phpextra   | PHP flavored markdown                              |
++--------------------+----------------------------------------------------+
+|markdown_strict     | Markdown with no added pandoc features             |
++--------------------+----------------------------------------------------+
+|mediawiki           | Popular wiki language                              |
++--------------------+----------------------------------------------------+
+|native              | Pandoc native Haskell                              |
++--------------------+----------------------------------------------------+
+|odt                 | Open document text (used by LibreOffice)           |
++--------------------+----------------------------------------------------+
+|opml                | Outline processor markup language                  |
++--------------------+----------------------------------------------------+
+|org                 | Org mode for Emacs                                 |
++--------------------+----------------------------------------------------+
+|rst                 | reStructuredText                                   |
++--------------------+----------------------------------------------------+
+|t2t                 | Wiki-like formatting syntax                        |
++--------------------+----------------------------------------------------+
+|textile             | A formatting syntax similar to RST and markdown    |
++--------------------+----------------------------------------------------+
+|twiki               | Popular wiki formatting syntax                     |
++--------------------+----------------------------------------------------+
 
 Fixing the converted document
 -----------------------------
@@ -106,5 +106,5 @@ Previewing edits
 Web-based
 ~~~~~~~~~
 
-`rst.ninjs.org <http://rst.ninjs.org>`_ has an excellent RST previewing
-tool that highlights RST errors with line numbers.
+`Online Sphinx editor <https://livesphinx.herokuapp.com/>`_ is a RST previewing
+tool.
index 73a32fa..e5a79d1 100644 (file)
@@ -1,3 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.  http://creativecommons.org/licenses/by/4.0
+.. Copyright ONAP Community
+
 |image2017-10-27_15-56-53.png|
 
 ONAP Portal for Administrators
@@ -25,7 +29,8 @@ Access
 Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac)
 at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`.
 
-:ref:`Access the ONAP portal via the 8989 LoadBalancer documented `here<onap-oom:onap-on-kubernetes-with-rancher>`
+Access the ONAP portal via the 8989 LoadBalancer documented
+:ref:` here<onap-oom:onap-on-kubernetes-with-rancher>`
 
 From the Portal, users access applications directly or by function using
 the `Manage menu`.
@@ -59,8 +64,8 @@ Admin Tasks
 
 From the ONAP Portal, administrators:
 
--  access the same functionality accessible to users (see `ONAP Portal
-   for users <onap-#PAGE_1018759>`__)
+-  access the same functionality accessible to users
+   (see :ref:`ONAP Portal for users<onap_portal_users>`)
 
 -  manage users and application admins
 
@@ -74,8 +79,6 @@ Administrators see the following menu when accessing the ONAP Portal:
 
 Left menu descriptions:
 
-.. _PAGE_1018764:
-
 Admins Menu
 -----------
 
index 8fd8854..50f6ccf 100644 (file)
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.  http://creativecommons.org/licenses/by/4.0
+.. ONAP community
+.. _onap_portal_users:
+
 |image2017-10-27_15-56-53.png|
 
 ONAP Portal for Users
@@ -16,7 +21,8 @@ manage applications and widgets, and manage user access.
 The Portal SDK for application developers includes bundled tools,
 technologies, and built-in capabilities such as services, APIs, and UI
 controls. Existing applications can migrate to the Portal with the
-provided APIs and libraries. :ref:`ONAP Portal SDK Documentation<onap-portal:master_index>`
+provided APIs and libraries.
+:ref:`ONAP Portal SDK Documentation<onap-portal:master_index>`
 
 Access
 ------
@@ -24,7 +30,8 @@ Access
 Access the ONAP Portal using Mozilla Firefox or Google Chrome(win/mac)
 at the provided URL. For example: `https://<hostname:port>/ONAPPORTAL/login.html`.
 
-:ref:`Access the ONAP portal via the 8989 LoadBalancer <onap-oom:onap-on-kubernetes-with-rancher>`
+:ref:`Access the ONAP portal via the 8989 LoadBalancer
+<onap-oom:onap-on-kubernetes-with-rancher>`
 
 From the Portal, users access applications directly or by function using
 the `Manage menu`.