Skip to content

Commit

Permalink
Updates according to agreed template.
Browse files Browse the repository at this point in the history
  • Loading branch information
hdamker committed May 8, 2024
1 parent f0f7711 commit 16e59f1
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,27 @@ Repository to describe, develop, document and test the DeviceStatus API family
* Describe, develop, document and test the APIs (with 1-2 Telcos)
* Started: July 2022

## Release Information

* The latest public release is available here: https://github.com/camaraproject/DeviceStatus/releases/latest
* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceStatus/blob/main/CHANGELOG.md)
<!-- * Further release information is available within (link to release tracker page on wiki when available) -->
<!-- Pre-releases are available in https://github.com/camaraproject/DeviceStatus/releases> -->

* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available public release**.

<!-- following part left in for now but could be omitted going forward -->
* The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1)
- API definition with inline documentation:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)

## Contributing
* Meetings
* Bi-weekly on Wednesday, 11:00 CET/CEST (08:00 UTC, 09:00 UTC during European DST)
* [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94783050047?password=c43ff9fd-4c79-468a-9d98-45222dd6343d)
* Maling List
* Subscribe <[email protected]>
* <https://lists.camaraproject.org/g/sp-dst>
* Lifecycle Status
* [Latest Release](https://github.com/camaraproject/DeviceStatus/releases/latest)
* Release Information: Link to wiki
* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
* The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1)
- API definition with inline documentation:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)

0 comments on commit 16e59f1

Please sign in to comment.