From 504a57bef078f30339bf163dc2f9f1766a809903 Mon Sep 17 00:00:00 2001 From: Rajat Kandoi Date: Fri, 6 Oct 2023 12:09:14 +0300 Subject: [PATCH 1/5] Improve README to enable easy discovery of Commonalities documents relevant to API subprojects --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e2fe069c..0e23f242 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,25 @@ Repository to describe and document common guidelines and assets for CAMARA APIs * Started: June 2023 * Location: virtually +## Documents for API Working Groups + +The documents that are relevant for CAMARA API Subprojects / CAMARA API Working Groups are found in the `documentation` directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group. + +The `artifacts` directory contains templates for creating Github issues and Common data and error formats for CAMARA APIs. + +A list of some of the most frequently accessed documents in the documentation directory is provided below. Note that the links point to the `main` branch of this repository. Refer to the section below for released versions. + +| Document name | Purpose | +|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | [API-design-guidelines.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | +| [API-DocumentationTemplate.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-DocumentationTemplate.md) | Template for documenting the APIs | +| [API-Readiness-Checklist.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready | +| [Camara_Versioning_Guidelines.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases | +| [Glossary.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs | + + + + ## Status and released versions * Release 0.1.0 of guidelines and assets for CAMARA APIs is available within the [release-0.1.0 branch](https://github.com/camaraproject/Commonalities/tree/release-0.1.0)): * For changes see [CHANGELOG.md](https://github.com/camaraproject/Commonalities/blob/main/CHANGELOG.md) From b9968e31dd81d232a6ade0e31e4455e32e88c44c Mon Sep 17 00:00:00 2001 From: Rajat Kandoi Date: Fri, 6 Oct 2023 13:44:17 +0300 Subject: [PATCH 2/5] Use relative links in the documents table --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0e23f242..1d8aa9eb 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,17 @@ The documents that are relevant for CAMARA API Subprojects / CAMARA API Working The `artifacts` directory contains templates for creating Github issues and Common data and error formats for CAMARA APIs. -A list of some of the most frequently accessed documents in the documentation directory is provided below. Note that the links point to the `main` branch of this repository. Refer to the section below for released versions. +### Frequently-accessed output documents + +A list of some of the frequently accessed documents that are an output of the work done in the Commonalities Working Group is provided below. Note that the links are relative to the branch selected. Refer to the section below for released versions. | Document name | Purpose | |-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [API-design-guidelines.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | -| [API-DocumentationTemplate.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-DocumentationTemplate.md) | Template for documenting the APIs | -| [API-Readiness-Checklist.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready | -| [Camara_Versioning_Guidelines.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases | -| [Glossary.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs | +| [API-DocumentationTemplate.md](documentation/API-DocumentationTemplate.md) | Template for documenting the APIs | +| [API-Readiness-Checklist.md](documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready | +| [Camara_Versioning_Guidelines.md](documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases | +| [Glossary.md](documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs | From b6883e275eace32f29921eede5c2a3d9b5042827 Mon Sep 17 00:00:00 2001 From: Rajat Kandoi Date: Fri, 6 Oct 2023 13:45:46 +0300 Subject: [PATCH 3/5] Fix relative link in output documents table --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d8aa9eb..530d5986 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ A list of some of the frequently accessed documents that are an output of the wo | Document name | Purpose | |-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | [API-design-guidelines.md](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | + | [API-design-guidelines.md](documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | | [API-DocumentationTemplate.md](documentation/API-DocumentationTemplate.md) | Template for documenting the APIs | | [API-Readiness-Checklist.md](documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready | | [Camara_Versioning_Guidelines.md](documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases | From 4762c7f7aeb0797cca03a4b479ea4705cd3aebf2 Mon Sep 17 00:00:00 2001 From: Rajat Kandoi <8538667+rkandoi@users.noreply.github.com> Date: Mon, 23 Oct 2023 09:40:57 +0300 Subject: [PATCH 4/5] Update README.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 530d5986..5137626a 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Repository to describe and document common guidelines and assets for CAMARA APIs * Started: June 2023 * Location: virtually -## Documents for API Working Groups +## Documents for CAMARA Sub Projects The documents that are relevant for CAMARA API Subprojects / CAMARA API Working Groups are found in the `documentation` directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group. From 83d1b38f7660cfc1af643534c657b9db316f2f14 Mon Sep 17 00:00:00 2001 From: Rajat Kandoi <8538667+rkandoi@users.noreply.github.com> Date: Mon, 23 Oct 2023 09:41:06 +0300 Subject: [PATCH 5/5] Update README.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5137626a..479d4db5 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Repository to describe and document common guidelines and assets for CAMARA APIs ## Documents for CAMARA Sub Projects -The documents that are relevant for CAMARA API Subprojects / CAMARA API Working Groups are found in the `documentation` directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group. +The documents that are relevant for CAMARA API Sub Projects are found in the `documentation` directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group. The `artifacts` directory contains templates for creating Github issues and Common data and error formats for CAMARA APIs.