diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 395155c7d6..231192166d 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repository code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Install prerequisites run: | sudo apt-get --allow-releaseinfo-change update -y && sudo apt-get install -y tox diff --git a/README.md b/README.md new file mode 100644 index 0000000000..f530832a81 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Anuket Specifications + + +This repository contains the governance and generic description of +[Anuket Specifications](https://cntt.readthedocs.io/en/stable-pieman/) +The actual technical specification is done in the following repositories: + +* Reference Model (RM): [anuket-project/RM](https://github.com/anuket-project/RM) +* Reference Architecture (RA1) for OpenStack based cloud infrastructure: + [anuket-project/RA1](https://github.com/anuket-project/RA1) +* Reference Conformance (RC1) for RA1 based Implementations: + [anuket-project/RC](https://github.com/anuket-project/RC) +* Reference Architecture (RA2) for Kubernetes based cloud infrastructure: + [anuket-project/RA2](https://github.com/anuket-project/RA2) +* Reference Conformance (RC2) for RA2 based Implementations: + [anuket-project/RC2](https://github.com/anuket-project/RC2) +* Reference Implementation based on RA1 specifications (RI1): + [anuket-project/RI1](https://github.com/anuket-project/RI1) +* Reference Implementation based on RA2 specifications (RI2): + [anuket-project/RI2](https://github.com/anuket-project/RI2) + +The development of the specifications happen in the respective repository of the sub-projects. Pull requests related to +the sub-projects should be created to the sub-project repos and not to this repo. + +## Navigation tips + +- **design your OpenStack product?** You would be primarily interested + in [the OpenStack requirement list](https://cntt.readthedocs.io/projects/ra1/en/latest/chapters/chapter02.html) + and [OpenStack API descriptions and selection](https://cntt.readthedocs.io/projects/ra1/en/latest/chapters/chapter05.html) +- **check the Anuket conformance of your OpenStack-based deployments?** + You would be primarily interested in [the OpenStack Testing Cookbook](https://cntt.readthedocs.io/projects/ra1/en/latest/chapters/chapter08.html#openstack-testing-cookbook) + and [the test case descriptions and selection](https://cntt.readthedocs.io/projects/ra1/en/latest/chapters/chapter08.html#conformance-test-suite) + for more details. +- **check the Anuket conformance of your Kubernetes-based deployments?** You would be primarily interested in + [Kubernetes Testing Cookbook](https://cntt.readthedocs.io/projects/rc2/en/latest/chapters/chapter03.html) + and [the test case descriptions and selection](https://cntt.readthedocs.io/projects/rc2/en/latest/chapters/chapter02.html) + for more details. +- **design your Kubernetes product?** You would be primarily interested in the + [Kubernetes requirement list](https://cntt.readthedocs.io/projects/ra2/en/latest/chapters/chapter02.html) + and [Kubernetes specifications](https://cntt.readthedocs.io/projects/ra2/en/latest/chapters/chapter04.html). +- **deploy OpenStack to onboard your VNFs?** You would be primarily interested in + [the Anuket reference implementation](https://cntt.readthedocs.io/projects/ri1/en/latest/chapters/chapter01.html) + +## Terms of Reference & License + +- [Terms of Reference](GSMA_CNTT_Terms_of_Reference.pdf) +- [Code of Conduct](CODE_OF_CONDUCT.rst) +- [The License (Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode) + +Read the Docs +------------- + +- [Wiki](https://wiki.anuket.io/) +- [Doc](https://cntt.readthedocs.io/en/latest/) diff --git a/README.rst b/README.rst deleted file mode 100644 index 886dd7061c..0000000000 --- a/README.rst +++ /dev/null @@ -1,71 +0,0 @@ -Anuket Specifications -===================== - -This repository contains the governance and generic description of `Anuket Specifications -`__. -The actual technical specification is done in the following repositories: - -* Reference Model (RM): `anuket-project/RM `__ -* Reference Architecture (RA1) for OpenStack based cloud infrastructure: - `anuket-project/RA1 `__ -* Reference Conformance (RC1) for RA1 based Implementations: - `anuket-project/RC `__ -* Reference Architecture (RA2) for Kubernetes based cloud infrastructure: - `anuket-project/RA2 `__ -* Reference Conformance (RC2) for RA2 based Implementations: - `anuket-project/RC2 `__ -* Reference Implementation based on RA1 specifications (RI1): - `anuket-project/RI1 `__ -* Reference Implementation based on RA2 specifications (RI2): - `anuket-project/RI2 `__ - -The development of the specifications happen in the respective repository of the sub-projects. Pull requests related to -the sub-projects should be created to the sub-project repos and not to this repo. - -Available Specifications ------------------------- - -- `Governance `__ -- `Technical - Specifications `__ - -Navigation tips ---------------- - -- **design your OpenStack product?** You would be primarily interested - in `the OpenStack requirement - list `__ - and `OpenStack API descriptions and - selection `__. -- **check the Anuket conformance of your OpenStack-based deployments?** - You would be primarily interested in `the OpenStack Testing - Cookbook `__ - and `the test case descriptions and - selection `__ - for more details. -- **check the Anuket conformance of your Kubernetes-based - deployments?** You would be primarily interested in `Kubernetes - Testing - Cookbook `__ - and `the test case descriptions and - selection `__ - for more details. -- **deploy OpenStack to onboard your VNFs?** You would be primarily - interested in `the Anuket reference - implementation `__ - -Terms of Reference & License ----------------------------- - -- `Terms of - Reference `__ -- `Code of - Conduct `__ -- `The License (Creative Commons Attribution 4.0 - International) `__ - -Read the Docs -------------- - -- `Wiki `__ -- `Doc `__ diff --git a/tox.ini b/tox.ini index 19ddd64a2e..9f60a7fea3 100644 --- a/tox.ini +++ b/tox.ini @@ -7,7 +7,7 @@ skipsdist = true [testenv:docs] basepython = python3.10 deps = - -chttps://opendev.org/openstack/requirements/raw/branch/stable/zed/upper-constraints.txt + -chttps://opendev.org/openstack/requirements/raw/branch/stable/2024.1/upper-constraints.txt -r{toxinidir}/test-requirements.txt commands = sphinx-build -W --keep-going -W -T -b html -D language=en doc _build/html