summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGergely Csatari <gegrely.csatari@nokia.com>2022-11-23 10:28:13 +0200
committerGergely Csatari <gergely.csatari@nokia.com>2022-12-16 10:27:20 +0200
commit397bbce7edc03354802dacd1524f5b306979ebd3 (patch)
treea94dd72a23c918bd66f8e9c0d295a7cdcf430451 /docs
parent70b880e98abbc1f51006633dc6ce9805d01c2f6f (diff)
[pcac]: Reworking the langing pagestable/nile
- Changing the intro text to be more clear and to refer all type of things Anuket delivers - Adding a figure about the Anuket project structure - Reorganizing the chapter structure beased on reader personas Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Change-Id: I4f5d5096abf45f782546b4621d016d2d03cf64d3
Diffstat (limited to 'docs')
-rw-r--r--docs/images/Anuket-structure.pngbin0 -> 397965 bytes
-rw-r--r--docs/images/Anuket-structure.pptxbin0 -> 54744 bytes
-rw-r--r--docs/index.rst99
3 files changed, 76 insertions, 23 deletions
diff --git a/docs/images/Anuket-structure.png b/docs/images/Anuket-structure.png
new file mode 100644
index 000000000..fb7d6c93e
--- /dev/null
+++ b/docs/images/Anuket-structure.png
Binary files differ
diff --git a/docs/images/Anuket-structure.pptx b/docs/images/Anuket-structure.pptx
new file mode 100644
index 000000000..de88427cd
--- /dev/null
+++ b/docs/images/Anuket-structure.pptx
Binary files differ
diff --git a/docs/index.rst b/docs/index.rst
index d9809e700..0d6c2e5f3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,23 +4,54 @@
Anuket Documentation
====================
-The Anuket project facilitates the development and evolution
-of cloud components across various open source ecosystems.
-Through preparation of reference specifications,
-system level integration, testing and deployment, Anuket creates
-reference implementations and conformance tests to accelerate the
-transformation of enterprise
-and service provider networks. Participation is open to anyone,
-whether you are an employee of a member company or just passionate
-about network transformation.
+The mission of the Anuket project is to empower the global communications community by creating and developing reference
+cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
+securely.
+
+Anuket approaches its mission by providing a set of cloud infrastructure reference
+specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
+projects.
+
+.. image:: /images/Anuket-structure.png
+ :alt: Project structure of Anuket
+
+
+Participation is open to anyone, whether you are an employee of a member company or just passionate about network
+transformation.
+
+Documentation for Anuket Users
+------------------------------
+
+These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
+sub-project categories.
Anuket Specifications
-----------------------
+~~~~~~~~~~~~~~~~~~~~~
+
+:doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
+workloads. The specifications are organized to the following documents:
-:doc:`Anuket Specifications <cntt:index>`
+* Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
+* Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
+ infrastructure based on the requirements of the Reference Model
+* Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
+ conformance of OpenStack cloud infrastrucutres and their workloads
+* Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
+ requirements of the RA1 specifications
+* Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
+ orchestration platform based on the requirements of the Reference Model
+* Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
+ conformance of OpenStack cloud infrastrucutres and their workloads
+* Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
+ platform based on the RA2 specificcations.
-Installation Guides and More
-----------------------------
+
+Implementation projects
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Implementation projects address specific needs in the cloud technology relevant for the community and provide a
+reuseable implementation. The implementation projects have their release notes, installation and user guides in the
+aggregated documentation set referred here:
.. toctree::
:maxdepth: 1
@@ -30,32 +61,54 @@ Installation Guides and More
release/release-notes
-Testing Frameworks
-------------------
+Testing Projects and Frameworks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
+the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
+and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
.. toctree::
:maxdepth: 1
- testing/testing-user
- testing/testing-dev
+ release/installation.introduction
+ release/userguide.introduction
+ release/release-notes
+
+Integration projects
+~~~~~~~~~~~~~~~~~~~~
-Infrastructure
---------------
+The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
+and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
+set referred here:
.. toctree::
:maxdepth: 1
- infrastructure/overview
- infrastructure/ci
+ release/installation.introduction
+ release/userguide.introduction
+ release/release-notes
+
+Documentation for Anuket contributors
+-------------------------------------
-Developer Guide
----------------
+Contribution guide for the documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
how-to-use-docs/index
+Software and hardware infrastructure guide
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ infrastructure/overview
+ infrastructure/ci
+
Glossary
--------