Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Turning README to an md file #3455

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Turning README to an md file #3455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba499f4
Turning README to an md file
CsatariGergely Oct 30, 2024
0ba9f25
Adding the content from #3448
CsatariGergely Nov 25, 2024
130f265
Bump checkout workflow version, bump upper constraints
CsatariGergely Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
54 changes: 54 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)
71 changes: 0 additions & 71 deletions README.rst
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading