Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 6458ba752df13912f3497576949f85192a9ca8b5 / . / docs / index.rst
blob: 91359b7851a4edbaa29e634e6911b62d60e8eec6 [file] [log] [blame]
Eric Debeau38c451a2018-11-30 20:03:37 +0000[diff] [blame]1.. This work is licensed under a
2 Creative Commons Attribution 4.0 International License.
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]3
Aric Gardnere2417212020-02-07 13:56:45 -0500[diff] [blame]4
Rich Bennettd1f09492017-07-25 19:28:00 -0400[diff] [blame]5.. _master_index:
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]6
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]7Open Network Automation Platform
8================================
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]9
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]10Open Network Automation Platform (ONAP) is an open source project hosted by
11the Linux Foundation.
Rich Bennett1959f682018-06-14 10:50:31 -0400[diff] [blame]12
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]13ONAP provides a comprehensive platform for real-time, policy-driven service
14orchestration and automation. ONAP enables service providers and developers
15to rapidly automate the instantiation and configuration of physical and
16virtual network functions and to support complete life cycle management
17activities. By unifying the resources of open source members, ONAP enables
18the acceleration of the development of a vibrant ecosystem around a globally
19shared architecture and the implementation of network automation faster than
20any product could on its own.
21
Noemi Wagnerf50d63d2019-05-17 10:22:04 +0200[diff] [blame]22Please find some guidance here on the content of ONAP documentation:
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]23
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]24 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Eric Debeauddbab332019-10-14 13:42:57 +0000[diff] [blame]25 | Main documentation areas | Description |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]26 +=================================================================================+===============================================================================================+
thmsdt8dc2fc32022-05-31 10:58:53 +0200[diff] [blame]27 | :ref:`ONAP Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,|
thmsdt671839c2022-05-03 09:44:01 +0200[diff] [blame]28 | | feature enhancements, or bug fixes. |
29 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
30 | :ref:`Project Specific Release Notes <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature |
31 | | enhancements, or bug fixes on a component level. |
Noemi Wagner01fab8e2019-05-30 13:55:09 +0200[diff] [blame]32 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]33 | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main |
34 | | functionalities of ONAP. Basic guidelines on license details, limitations and |
35 | | security references support understanding the solution. |
36 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]37 | :ref:`ONAP Architecture <ONAP-architecture>` | The ONAP Architecture and its functional elements are described in details |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]38 | | here. We can learn how the two main frameworks, namely the Design-time |
39 | | framework and the Run-time framework cooperate and how the Microservices, |
40 | | Common services and the ONAP Portal support the certain functions. |
41 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]42 | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. |
thmsdtae619be2021-12-20 13:32:38 +0100[diff] [blame]43 | | We can learn what functionalities ONAP provides and how the certain components in |
44 | | ONAP operate together. |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]45 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]46 | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, |
47 | | its management, monitoring and other operational tasks (integration, user management,...) |
48 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
49 | :ref:`User Guides <user-guides>` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, |
50 | | instantiation and their management using control loops |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]51 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
52 | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information |
53 | | in the Developer Guides. The reader can search among the developers’ topics |
54 | | in alphabetical order. |
55 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]56 | :ref:`Documentation Guides <ONAP_documentation_guides>` | People interested in the creation of ONAP documentation can find crucial information |
57 | | in the ONAP Documentation Guide. Currently some content resides also in the Developer Guide. |
58 | | This is subject to be reviewed, updated and migrated to the ONAP Documenation Guide. |
59 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt6458ba72022-06-27 16:45:45 +0200[diff] [blame^]60 | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed |
61 | | vulnerabilities. |
62 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Aric Gardner0fb94b12020-01-28 15:21:34 -0500[diff] [blame]63
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]64.. toctree::
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]65 :maxdepth: 1
66 :hidden:
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]67
Noemi Wagner2d7727c2019-01-08 09:55:19 +0100[diff] [blame]68 Home <self>
MatthewHarffy8e73d8b2017-09-14 15:29:34 +0100[diff] [blame]69 release/index
thmsdt671839c2022-05-03 09:44:01 +0200[diff] [blame]70 release/releaserepos
Noemi Wagner01fab8e2019-05-30 13:55:09 +0200[diff] [blame]71 guides/overview/index
Andrea Visnyei1a4fc332019-02-15 13:50:54 +0100[diff] [blame]72 guides/onap-developer/architecture/index
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]73 guides/onap-developer/developing/index
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]74 guides/onap-operator/index
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]75 guides/onap-user/index
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]76 guides/onap-developer/index
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]77 guides/onap-documentation/index