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.

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

docs: Unification of documentation #1955

Merged
merged 1 commit into from
Jun 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/2-new-workload.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,16 @@ assignees: ""
- tbd

**Test Category Name**
- ADD CATEGORY_NAME (e.g. State, Security, etc from [README](https://github.com/cncf/cnf-testsuite/blob/main/README.md#cnf-testsuite))
- ADD CATEGORY_NAME (e.g. State, Security, etc from [README](../../README.md#cnf-testsuite))

**Type of test (static or runtime)**
- tbd

---

### Documentation tasks:
- [ ] Update [installation instructions](https://github.com/cncf/cnf-testsuite/blob/main/install.md) if needed
- [ ] Update [Test Categories md](https://github.com/cncf/cnf-testsuite/blob/main/TEST-CATEGORIES.md) if needed
- [ ] Update [USAGE md](https://github.com/cncf/cnf-testsuite/blob/main/USAGE.md) if needed
- [ ] Update [installation instructions](../../INSTALL.md) if needed
- [ ] Update [TEST_DOCUMENTATION md](../../docs/TEST_DOCUMENTATION.md) if needed
- [ ] How to run
- [ ] Description and details
- [ ] What the best practice is
Expand Down
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/3-new-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@ assignees: ""

**Documentation tasks:**

- [ ] Update [Test Categories md](https://github.com/cncf/cnf-testsuite/blob/main/TEST-CATEGORIES.md) if needed
- [ ] Update [Pseudo Code md](https://github.com/cncf/cnf-testsuite/blob/main/PSEUDO-CODE.md) if needed
- [ ] Update [USAGE md](https://github.com/cncf/cnf-testsuite/blob/main/USAGE.md) if needed
- [ ] Update [installation instructions](https://github.com/cncf/cnf-testsuite/install.md) if needed
- [ ] Update [TEST_DOCUMENTATION md](../../docs/TEST_DOCUMENTATION.md) if needed
- [ ] Update [installation instructions](../../install.md) if needed

### QA tasks

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/ignore/5-proof-of-concept.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Tasks:
- [ ] Select a tool to use, minimal/least effort, and add selection to ticket
- [ ] Add new POC test code
- [ ] Add comment suggesting updates as needed for:
- [ ] the [test categories markdown](https://github.com/cncf/cnf-testsuite/blob/main/TEST-CATEGORIES.md)
- [ ] the [psuedo code markdown](https://github.com/cncf/cnf-testsuite/blob/main/PSEUDO-CODE.md)
- [ ] the [TEST_DOCUMENTATION md](../../../docs/TEST_DOCUMENTATION.md)
- [ ] the [psuedo code markdown](../../../PSEUDO-CODE.md)
- [ ] slide content updates, LINK_TO_UPDATES
- [ ] the [README](https://github.com/cncf/cnf-testsuite/blob/main/README.md)
- [ ] the [README](../../../README.md)
- [ ] Tag 1 or more people to peer review
2 changes: 1 addition & 1 deletion CNF_TESTSUITE_YML_USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Example Setting:

#### helm_install_namespace

This sets the namespace that helm will use to install the CNF to. This is to conform to the best practice of not installing your CNF to the `default` namespace on your cluster. You can learn more about this practice [here](./docs/LIST_OF_TESTS.md#default-namespaces). This is an optional setting but highly recommended as installing your CNF to use the `default` namespace will result with failed tests.
This sets the namespace that helm will use to install the CNF to. This is to conform to the best practice of not installing your CNF to the `default` namespace on your cluster. You can learn more about this practice [here](./docs/TEST_DOCUMENTATION.md#default-namespaces). This is an optional setting but highly recommended as installing your CNF to use the `default` namespace will result with failed tests.

You can learn more about kubernetes namespaces [here](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)

Expand Down
383 changes: 0 additions & 383 deletions RATIONALE.md

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The CNTI Test Catalog will inspect CNFs for the following characteristics:
- **Observability & Diagnostics** - CNFs should externalize their internal states in a way that supports metrics, tracing, and logging.
- **Security** - CNF containers should be isolated from one another and the host. CNFs are to be verified against any common CVE or other vulnerabilities.

See the [Test Categories Documentation](TEST-CATEGORIES.md) for a complete overview of the tests.
See the [Complete Test Documentation](docs/TEST_DOCUMENTATION.md) for a complete overview of the tests.

## Contributing

Expand Down
8 changes: 4 additions & 4 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ To get a more complete overview of planned features and current work see the [pr
- Build tests for Kubernetes best practices that address issues voiced by the end users, including:
- On-boarding (day 1) items
- CNF WG best practices
- Build [resilience tests](https://github.com/cnti-testcatalog/testsuite/blob/main/USAGE.md#resilience-tests) using [LitmusChaos](https://litmuschaos.io/) experiments
- Create [observability tests](https://github.com/cnti-testcatalog/testsuite/blob/main/USAGE.md#observability-tests) to check for cloud native monitoring
- Create [state tests](https://github.com/cnti-testcatalog/testsuite/blob/main/USAGE.md#state-tests) to check cloud native data handling
- Create [security tests](https://github.com/cnti-testcatalog/testsuite/blob/main/USAGE.md#security-tests)
- Build [resilience tests](https://github.com/cnti-testcatalog/testsuite/blob/main/docs/TEST_DOCUMENTATION.md#category-reliability-resilience--availability-tests) using [LitmusChaos](https://litmuschaos.io/) experiments
- Create [observability tests](https://github.com/cnti-testcatalog/testsuite/blob/main/docs/TEST_DOCUMENTATION.md#category-observability--diagnostic-tests) to check for cloud native monitoring
- Create [state tests](https://github.com/cnti-testcatalog/testsuite/blob/main/docs/TEST_DOCUMENTATION.md#category-state-tests) to check cloud native data handling
- Create [security tests](https://github.com/cnti-testcatalog/testsuite/blob/main/docs/TEST_DOCUMENTATION.md#category-security-tests)

### Enhance the functionality of the test suite framework

Expand Down
123 changes: 0 additions & 123 deletions TEST-CATEGORIES.md

This file was deleted.

Loading