summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-user/onap-portal-user
diff options
context:
space:
mode:
authorThomas Kulik <thomas.kulik@telekom.de>2020-02-28 08:40:49 +0100
committerThomas Kulik <thomas.kulik@telekom.de>2020-02-28 08:45:05 +0100
commitafca839ffc955efcee957888d7f9de0f77bcb74a (patch)
tree99f408a41117c7b5b45c12c3de8b2cd5b338d9c7 /docs/guides/onap-user/onap-portal-user
parentc1e90586aa75e092e04ae3e755159a56d59c1697 (diff)
Issue-ID: DOC-506
Portal Doc migrated from DevWiki to RTD; splitted into User and Admin parts Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de> Change-Id: I24874f876865a377f7efe49b2d6519d6f0d1b66b
Diffstat (limited to 'docs/guides/onap-user/onap-portal-user')
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.pngbin0 -> 9974 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.pngbin0 -> 88069 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.pngbin0 -> 149071 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.pngbin0 -> 32239 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.pngbin0 -> 50214 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.pngbin0 -> 34441 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.pngbin0 -> 112003 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.pngbin0 -> 58082 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.pngbin0 -> 23415 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.pngbin0 -> 47684 bytes
-rw-r--r--docs/guides/onap-user/onap-portal-user/onap-portal-user.rst172
11 files changed, 172 insertions, 0 deletions
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png b/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png
new file mode 100644
index 000000000..6490e9c17
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/1018906_ep_home_editwidget.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png b/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png
new file mode 100644
index 000000000..1178279bd
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/16004284_image2017-10-27_14-14-37.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png b/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png
new file mode 100644
index 000000000..4e8972586
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/16004343_image2017-10-27_15-56-53.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png b/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png
new file mode 100644
index 000000000..454c6b9fc
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/16004980_image2017-10-31_12-21-53.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png b/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png
new file mode 100644
index 000000000..e7b808d9f
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086818_image2017-12-5_14-53-43.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png b/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png
new file mode 100644
index 000000000..977808e8f
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086819_image2017-12-5_14-57-22.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png b/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png
new file mode 100644
index 000000000..88626eaf9
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086820_image2017-12-5_15-8-37.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png b/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png
new file mode 100644
index 000000000..516adc748
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086821_image2017-12-5_15-9-27.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png b/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png
new file mode 100644
index 000000000..166243820
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086839_image2017-12-5_16-52-40.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png b/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png
new file mode 100644
index 000000000..c2c361f2d
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/attachments/20086846_image2017-12-5_16-57-24.png
Binary files differ
diff --git a/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst
new file mode 100644
index 000000000..7ce2f3a08
--- /dev/null
+++ b/docs/guides/onap-user/onap-portal-user/onap-portal-user.rst
@@ -0,0 +1,172 @@
+|image2017-10-27_15-56-53.png|
+
+ONAP Portal for Users
+=====================
+
+General
+-------
+
+The ONAP Portal platform integrates different ONAP applications into a
+central core. The Portal platform provides common management services
+and connectivity, while the applications run separately.
+
+From the Portal, users access applications. Administrators onboard and
+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. See `ONAP Portal SDK
+Documentation <http://onap.readthedocs.io/en/latest/submodules/portal.git/docs/tutorials/index.html>`__\.
+
+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`.
+
+Access the ONAP portal via the 8989 LoadBalancer documented `here <https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_user_guide.html#accessing-the-onap-portal-using-oom-and-a-kubernetes-cluster>`__
+
+From the Portal, users access applications directly or by function using
+the `Manage menu`.
+
+See also:
+
+- `Applications in the Portal`
+
+- `Application Catalog`
+
+Roles
+-----
+
+The Portal displays different menus for the following functions:
+
+- Users
+
+- Portal Admins
+
+- Application Admins
+
+- Governor
+
+- Operator
+
+Each application also defines a distinct set of user roles. See *Users* .
+
+Portal personalization and features
+-----------------------------------
+
+Show and hide the left menu
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To hide the left menu, click the menu icon. Click the menu icon again to
+show the menu.
+
+|image2017-10-31_12-21-53.png|
+
+Applications
+~~~~~~~~~~~~
+
+Access applications in the Portal directly from the `Application Catalog`
+or using the `Manage menu`.
+All the default applications in the ONAP Portal are integrated, but
+applications may also be onboarded as hyperlink-only. Integrated
+applications open in tabs below the header in the Portal; linked
+applications open in a new browser window. To close an integrated
+application, click the x in the tab.
+
+|image2017-12-5_14-53-43.png|
+
+A maximum of six applications (tabs) can be open at once in the ONAP
+Portal.
+
+Manage menu
+-----------
+
+The Manage menu provides links to applications by function. Choose from
+a list of functional or management tasks for each area. This example
+shows the options in the top-level functional Design category:
+
+|image2017-12-5_14-57-22.png|
+
+Favorites
+~~~~~~~~~
+
+Hover over a menu item and click the star beside it to add it to
+Favorites. Click the star again to remove the item from Favorites.
+
+Editing the Menu
+~~~~~~~~~~~~~~~~
+
+Portal Admins edit and manage the menu. See `Edit Functional Menu`
+
+Support Menu
+------------
+
+The Support menu provides Contact Us and Get Access links. Portal admins
+can add contact details and also edit Support menu. See `Edit Functional Menu`.
+
+Home
+----
+
+Home is the default view after login.
+
+|image2017-12-5_16-52-40.png|
+
+Personalize the Home Page
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add or remove applications using the `Application Catalog`.
+Sort applications or widgets by clicking the drag handle to drag and
+drop the application or widget to a new location.
+
+|image2017-12-5_16-57-24.png| Add, manage, and edit what appears in the
+widgets by clicking the settings icon and selecting Edit.
+
+|ep_home_editwidget.png|
+
+Application Catalog
+-------------------
+
+Use the Application Catalog to select which application should appear on
+your Home page. Applications with a check mark already appear on the
+Home page.
+
+- To select an application to appear on the Home page, click the check
+ box in the top right corner of the application tile.
+
+- To remove an application from the Home page, click the check box
+ again.
+
+- Use the Filter to view specific applications: All applications,
+ Accessible (currently available) applications, or applications On
+ Home Page.
+
+- Click the drag handle to sort application tiles in the Application
+ Catalog.
+
+|image2017-12-5_15-8-37.png|
+
+Widget Catalog
+--------------
+
+Widgets are small applications that interact with their host application
+and each other to provide quick access for certain tasks. Use the
+Widgets section to view and interact with widgets.
+
+- Click a widget tile to open the widget.
+
+- Click the drag handle to sort widget tiles.
+
+|image2017-12-5_15-9-27.png|
+
+
+.. |image2017-10-27_15-56-53.png| image:: attachments/16004343_image2017-10-27_15-56-53.png
+.. |image2017-10-31_12-21-53.png| image:: attachments/16004980_image2017-10-31_12-21-53.png
+.. |image2017-12-5_14-53-43.png| image:: attachments/20086818_image2017-12-5_14-53-43.png
+.. |image2017-12-5_14-57-22.png| image:: attachments/20086819_image2017-12-5_14-57-22.png
+.. |image2017-12-5_16-52-40.png| image:: attachments/20086839_image2017-12-5_16-52-40.png
+.. |image2017-12-5_16-57-24.png| image:: attachments/20086846_image2017-12-5_16-57-24.png
+.. |ep_home_editwidget.png| image:: attachments/1018906_ep_home_editwidget.png
+.. |image2017-12-5_15-8-37.png| image:: attachments/20086820_image2017-12-5_15-8-37.png
+.. |image2017-12-5_15-9-27.png| image:: attachments/20086821_image2017-12-5_15-9-27.png