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

Improve discovery of Commonalties output documents by API Subprojects #73

Merged
merged 5 commits into from
Nov 6, 2023
Merged

Improve discovery of Commonalties output documents by API Subprojects #73

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
504a57b
Improve README to enable easy discovery of Commonalities documents re…
rkandoi Oct 6, 2023
b9968e3
Use relative links in the documents table
rkandoi Oct 6, 2023
b6883e2
Fix relative link in output documents table
rkandoi Oct 6, 2023
4762c7f
Update README.md
rkandoi Oct 23, 2023
83d1b38
Update README.md
rkandoi Oct 23, 2023
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,27 @@ Repository to describe and document common guidelines and assets for CAMARA APIs
* Started: June 2023
* Location: virtually

## Documents for CAMARA Sub Projects

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.

### 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](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 |
| [Glossary.md](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)
Expand Down