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.

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

Patch release r1.3 #383

Merged
merged 8 commits into from
Dec 18, 2024
Merged

Conversation

hdamker
Copy link
Collaborator

@hdamker hdamker commented Dec 10, 2024

What type of PR is this?

  • subproject management
  • documentation

What this PR does / why we need it:

Update of README and changelog for patch release r1.3
Updating release numbers and API versions across all files
Replacing links to main branch with release specific links (closing the remaining issue from the patch release scope in #

Which issue(s) this PR fixes:

Fixes #381
Fixes #363

Special notes for reviewers:

Create temporarily created branch r1.3 from main to be able to test the links. That branch will need be deleted before the release tag can be created.

Changelog input

na

@hdamker hdamker added documentation Improvements or additions to documentation subproject management labels Dec 10, 2024
@hdamker
Copy link
Collaborator Author

hdamker commented Dec 10, 2024

@RandyLevensalor @eric-murray @jlurien could you have a view on this PR ... I suppose that we are ready for the patch release, but would be great to double-check the CHANGELOG etc.

eric-murray
eric-murray previously approved these changes Dec 17, 2024
Copy link
Collaborator

@RandyLevensalor RandyLevensalor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hdamker Can you please update documentation/API_documentation/qos-profiles-API-Readiness-Checklist.md to include that we now have a user story?

jlurien
jlurien previously approved these changes Dec 17, 2024
Copy link
Collaborator

@jlurien jlurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor suggestions

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jose Luis Urien <[email protected]>
@hdamker hdamker dismissed stale reviews from jlurien and eric-murray via d340cd8 December 17, 2024 17:04
hdamker and others added 3 commits December 17, 2024 18:05
Co-authored-by: Jose Luis Urien <[email protected]>
Co-authored-by: Jose Luis Urien <[email protected]>
@hdamker
Copy link
Collaborator Author

hdamker commented Dec 17, 2024

@hdamker Can you please update documentation/API_documentation/qos-profiles-API-Readiness-Checklist.md to include that we now have a user story?

@RandyLevensalor Sure ... done in 2b223a8

@hdamker
Copy link
Collaborator Author

hdamker commented Dec 17, 2024

LGTM with minor suggestions

@jlurien Thanks for the review, all suggestions committed.

@@ -14,7 +14,7 @@ info:
- Discovery of all QoS profiles offered by the network operator
- Retrieve the characteristics of a specific QoS profile by name

How QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. [CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)](https://github.com/camaraproject/QualityOnDemand/blob/main/documentation/API_documentation/QoSProfile_Mapping_Table.md)
How QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. [CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/documentation/API_documentation/QoSProfile_Mapping_Table.md)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change: communication service provider --> API provider
possibly also change: API invoker --> API consumer

@@ -14,7 +14,7 @@ info:
- Discovery of all QoS profiles offered by the network operator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change multiple occurrences of : network operator --> API provider

  • this comment also applies to the other API yamls
  • same comment applies to the qos-profiles-UserStory.md (CSP/network operator -> API provider)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The abbreviation QoS is introduced in the middel of the intro paragraph rather than at the first occurrence.
  • the text uses QoS Profiles with capital P - would change to lower case.
  • Would add a simple explanation of what is a QoS profile in the beginning e.g. a QoS profile is a set of traffic characteristics of a session identified by a name (label) that can be used in session requests to indicate the needs of the application for its traffic.
  • this comment also applies to the other API yamls

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 138: the example is mixed up:

@tanjadegroot
Copy link

Hi Herbert, sorry for the delay. I reviewed and have some comments, but you may decide to apply them in the next release.

OK to go from release management team

@hdamker
Copy link
Collaborator Author

hdamker commented Dec 18, 2024

Hi Herbert, sorry for the delay. I reviewed and have some comments, but you may decide to apply them in the next release.

Hi Tanja, thanks for the comments. I created a new issue to consider them within the next release, they are going beyond the scope of a release PR.

@hdamker hdamker merged commit 64a1f06 into camaraproject:main Dec 18, 2024
2 checks passed
@hdamker hdamker deleted the 381-create-r13-patch-release branch December 18, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation subproject management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create release PR for r1.3 (patch release) Local links within API documentation have to be release specific
5 participants