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

Update README.md according to camaraproject/Template_Lead_Repository #67

Merged
merged 1 commit into from
Jul 24, 2024
Merged

Update README.md according to camaraproject/Template_Lead_Repository #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 27 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,39 @@
<a href="https://github.com/camaraproject/HomeDevicesPrioritization/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/HomeDevicesPrioritization?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesPrioritization/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/HomeDevicesPrioritization?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesPrioritization/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/HomeDevicesPrioritization?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesPrioritization/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/HomeDevicesPrioritization?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesPrioritization" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/HomeDevicesPrioritization?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesPrioritization/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/HomeDevicesQoD/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/HomeDevicesQoD?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesQoD/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/HomeDevicesQoD?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesQoD/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/HomeDevicesQoD?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesQoD/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/HomeDevicesQoD?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesQoD" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/HomeDevicesQoD?style=plastic"></a>
<a href="https://github.com/camaraproject/HomeDevicesQoD/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/HomeDevicesQoD/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/HomeDevicesQoD?style=plastic"></a>

# HomeDevicesQoD
Repository to describe, develop, document and test the HomeDevicesQoD API family

## Scope
* Service APIs for “HomeDevicesQoD” (see APIBacklog.md)
* It provides the customer with the ability to:
* change, on demand, the desired QoS behaviour of an specific device traffic on the user home network.
* Describe, develop, document and test the APIs (with 1-2 Telcos)
* Started: October 2022
* Location: virtually
* change, on demand, the desired QoS behaviour for the IP traffic corresponding to a specific user home device.
* Describe, develop, document and test the APIs
* Started: October 2022

## Meetings
* Meetings are held virtually.
* Schedule: ~~bi-weekly~~ on demand(*), Thursday, 4:30pm CET.
* **(*)NOTE: The project is currently stable, so meetings will be scheduled according to the needs of the working group participants. Offline updates will be provided on the mailing list as needed instead.** If anyone in the working group would like to have one of the following meetings, please send an email to the list and/or open a new issue in the repository so that everyone can keep track of new topics to discuss.
* Meeting link: <a href="https://teams.microsoft.com/l/meetup-join/19%3ameeting_NzJkZDc4MjktNjU1YS00NzYxLWExNzgtZDlmNzI5MmMxMGNi%40thread.v2/0?context=%7b%22Tid%22%3a%229744600e-3e04-492e-baa1-25ec245c6f10%22%2c%22Oid%22%3a%22458d45b0-4ca7-41e2-a7b3-3d722abf4468%22%7d">Microsoft Teams Meeting</a>

## Status & released versions
## Release Information
* Note: Please be aware that the project will have 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.3.0 is available within the [release-0.3.0 branch](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.3.0):
* **The latest public release `v0.3.0` is available [here](https://github.com/camaraproject/HomeDevicesQoD/tree/v0.3.0)**
* API definition **with inline documentation**:
* OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/release-0.3.0/code/API_definitions/home_devices_qod.yaml)
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.3.0/code/API_definitions/home_devices_qod.yaml&nocors)
* [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.3.0/code/API_definitions/home_devices_qod.yaml)
* API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.3.0/documentation/API_documentation)
* The previous released version v0.2.0 is available within the [release-0.2.0 branch](https://github.com/camaraproject/HomeDevicesQoD/tree/release-0.2.0).
* [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/v0.3.0/code/API_definitions/home_devices_qod.yaml&nocors)
* [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/v0.3.0/code/API_definitions/home_devices_qod.yaml)
* OpenAPI [YAML spec file](https://github.com/camaraproject/HomeDevicesQoD/blob/v0.3.0/code/API_definitions/home_devices_qod.yaml)
* API additional [related documentation](https://github.com/camaraproject/HomeDevicesQoD/tree/v0.3.0/documentation/API_documentation)
* Other releases of this sub project are available in https://github.com/camaraproject/HomeDevicesQoD/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/HomeDevicesQoD/blob/main/CHANGELOG.md)

## 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-hdp>.
* A message to all Contributors of this Sub Project can be sent using <sp-hdp@lists.camaraproject.org>.
## Contributing
* Meetings
* [Registration / Join](https://teams.microsoft.com/l/meetup-join/19%3ameeting_NzJkZDc4MjktNjU1YS00NzYxLWExNzgtZDlmNzI5MmMxMGNi%40thread.v2/0?context=%7b%22Tid%22%3a%229744600e-3e04-492e-baa1-25ec245c6f10%22%2c%22Oid%22%3a%22458d45b0-4ca7-41e2-a7b3-3d722abf4468%22%7d) (Microsoft Teams Meeting)
* Schedule: ~~bi-weekly~~ on demand(*), Thursday, 4:30pm CET.
* **(*)NOTE: The project is currently stable, so meetings will be scheduled according to the needs of the working group participants. Offline updates will be provided on the mailing list as needed instead.** If anyone in the working group would like to have one of the following meetings, please send an email to the list and/or open a new issue in the repository so that everyone can keep track of new topics to discuss.
* Minutes: Access [meeting minutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes).
* Mailing List
* Subscribe / Unsubscribe to the mailing list of this Sub Project <https://lists.camaraproject.org/g/sp-hdp>.
* A message to the community of this Sub Project can be sent using <sp-hdp@lists.camaraproject.org>.