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

Update README.md #139

Merged
merged 3 commits into from
May 13, 2024
Merged

Update README.md #139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0f7711
Update README.md
wrathwolf Apr 11, 2024
16e59f1
Updates according to agreed template.
hdamker May 8, 2024
efd99cb
Update README.md
hdamker May 9, 2024
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
30 changes: 19 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<a href="https://github.com/camaraproject/DeviceStatus/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/DeviceStatus?style=plastic"></a>
<a href="https://github.com/camaraproject/DeviceStatus" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/DeviceStatus?style=plastic"></a>
<a href="https://github.com/camaraproject/DeviceStatus/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
<a href="https://github.com/camaraproject/DeviceStatus/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/DeviceStatus?style=plastic"></a>

# DeviceStatus
Repository to describe, develop, document and test the DeviceStatus API family
Expand All @@ -14,23 +15,30 @@ Repository to describe, develop, document and test the DeviceStatus API family
* check if a device is losing connection to the network or gets reachable again, and the roaming status.
* NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
* Describe, develop, document and test the APIs (with 1-2 Telcos)
* Started: July 2022
* Location: virtually
* Started: July 2022

## Meetings
* Meetings are held virtually
* Schedule: bi-weekly (odd weeks), Wednesday, 11 AM CET
* Meeting link: <a href="https://teams.microsoft.com/l/meetup-join/19%3ameeting_NDQwYTlkZjYtOTc0NS00MjA5LWE2YjItMWFjYTczZTM4NTEx%40thread.v2/0?context=%7b%22Tid%22%3a%22bde4dffc-4b60-4cf6-8b04-a5eeb25f5c4f%22%2c%22Oid%22%3a%22389ab01b-6fbd-4e02-8f1a-1be1e09c95e8%22%7d">Microsoft Teams Meeting</a>
## Release Information

## Status and released versions
* 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 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)
hdamker marked this conversation as resolved.
Show resolved Hide resolved

## Contributorship and mailing list
* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-dst>.
* A message to all Contributors of this Sub Project can be sent using <[email protected]>.
## 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)
* Access [meeting minutes](https://wiki.camaraproject.org/x/5oAuAQ)
* Mailing List
* Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-dst.
* A message to the community of this Sub Project can be sent using <[email protected]>.