Skip to content

Commit

Permalink
Repo lockdown (#3423)
Browse files Browse the repository at this point in the history
* [RA2, RC2, RI2]: Removal of .readthedocs.yaml

They seem to cause a circular reference in the documentation.

Signed-off-by: Gergely Csatari <[email protected]>

* [root]: Disabling pull requests

Pull requests to RM, RA1, RI1, RC1, RA2, RI2 and RC2 should be opened in their
respective repository and not here.

Signed-off-by: Gergely Csatari <[email protected]>

* [RM, RA*, RI*, RC*]: Removal the repos moved to individual repos

Signed-off-by: Gergely Csatari <[email protected]>

* Fixing build errors

Signed-off-by: Gergely Csatari <[email protected]>

---------

Signed-off-by: Gergely Csatari <[email protected]>
  • Loading branch information
CsatariGergely authored Feb 20, 2024
1 parent 8c232a2 commit 5756cf4
Show file tree
Hide file tree
Showing 388 changed files with 52 additions and 30,814 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/repo-lockdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: 'Repo Lockdown'

on:
pull_request_target:
types: opened
paths:
- doc/ref_arch/**
- doc/ref_cert/**
- doc/ref_impl/**
- doc/ref_model/**

permissions:
pull-requests: write

jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/repo-lockdown@v4
with:
github-token: ${{ github.token }}
pr-comment: 'This repository does not accept pull requests, see README for details.'
skip-closed-pr-comment: true
close-pr: true
1 change: 1 addition & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Issues
Pull Requests
-------------

- Every sub-project should hadle their own PR-s in their respective repository.
- Minor editorial change PRs can be raised without a corresponding
Issue, but must be labelled as “Minor”. Otherwise, PRs must only be
created when there is an issue present and a decision to create a PR
Expand Down
27 changes: 22 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
Anuket
======
Anuket Specifications
=====================

This repository contains specification and documentation of the
Reference Model, Reference Architectures, Reference Implementations and
Reference Conformance projects of `Anuket <https://anuket.io/>`__.
This repository contains the governance and generic description of `Anuket Specifications
<https://cntt.readthedocs.io/en/stable-orinoco//>`__.
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.

Available Specifications
------------------------
Expand Down
6 changes: 5 additions & 1 deletion doc/common/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,11 @@ The various workstreams in the Anuket Project are:
- Reference Implementation (RI)
- Reference Conformance (RC)

The workstream dependency relationship in simple terms, `Reference Conformance <../ref_cert>`__ verifies and tests the `Reference Implementation <../ref_impl>`__ which follows the requirements and architecture defined in the `Reference Architectures <../ref_arch>`__ and Reference Architecture describes the high level system components and its interactions by adhering to the requirements and expectations set by the `Reference Model <../ref_model>`__ which sets the standards for infrastructure abstraction, compliance and verification.
The workstream dependency relationship in simple terms, Reference Conformance verifies and tests the Reference
Implementation which follows the requirements and architecture defined in the Reference Architectures and Reference
Architecture describes the high level system components and its interactions by adhering to the requirements and
expectations set by the Reference Model which sets the standards for infrastructure abstraction, compliance and
verification.

For the standard release stabilisation, On each release, All documents that are related to each other will have the same **main** version number as shown in the Figure 3.

Expand Down
1 change: 0 additions & 1 deletion doc/ref_arch/README.rst

This file was deleted.

Binary file removed doc/ref_arch/figures/ref-arch-figures.pptx
Binary file not shown.
Binary file removed doc/ref_arch/figures/ref_arch_ra2_relationships.png
Binary file not shown.
Binary file removed doc/ref_arch/figures/ref_arch_relationships.png
Binary file not shown.
8 changes: 0 additions & 8 deletions doc/ref_arch/index.rst

This file was deleted.

15 changes: 0 additions & 15 deletions doc/ref_arch/kubernetes/.readthedocs.yaml

This file was deleted.

35 changes: 0 additions & 35 deletions doc/ref_arch/kubernetes/README.rst

This file was deleted.

Binary file removed doc/ref_arch/kubernetes/_static/anuket-logo.png
Binary file not shown.
66 changes: 0 additions & 66 deletions doc/ref_arch/kubernetes/_static/custom.css

This file was deleted.

Binary file removed doc/ref_arch/kubernetes/_static/favicon.ico
Binary file not shown.
97 changes: 0 additions & 97 deletions doc/ref_arch/kubernetes/chapters/appendix-a.rst

This file was deleted.

Loading

0 comments on commit 5756cf4

Please sign in to comment.