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

Updated documentation, aligned with CAMARA glossary and ICM 0.3.0 #409

Merged
merged 5 commits into from
Jan 27, 2025

Conversation

hdamker
Copy link
Collaborator

@hdamker hdamker commented Jan 27, 2025

What type of PR is this?

Add one of the following kinds:

  • correction (alignment with ICM 0.3)
  • documentation (use of CAMARA glossary terms)

What this PR does / why we need it:

Editorial changes across the YAML files and the QoSProfile_Mapping_Table.md, including:

  • Use the terms API consumer and API provider where appropriate
  • Use neutral terms instead of "mobile networks" or similar
  • Minor changes, typos etc
  • Replaced the Authorization section in all three info.description
  • Align endpoint descriptions with the new way to identify a device as the subject of the API

Which issue(s) this PR fixes:

Fixes #402 #408

Special notes for reviewers:

Please note additional needed replacements in the review comments, I'm sure that I have overseen some.

Changelog input

Updated documentation, aligned with CAMARA glossary and ICM 0.3.0

Replaced terms to align with CAMARA glossary
Replaced Authorization section with text from ICM r2.2 version
Further alignments and editorial changes
Replaced terms to align with CAMARA glossary
Replaced Authorization section with text from ICM r2.2 version
Further alignments and editorial changes
Replaced terms to align with CAMARA glossary
Replaced Authorization section with text from ICM r2.2 version
Further alignments and editorial changes
Replaced terms according to CAMARA glossary
Neutral formulation regarding type of networks
@hdamker hdamker added documentation Improvements or additions to documentation correction correction in documentation or alignment with commonalities Spring25 Issue in scope of Spring25 meta-release cycle labels Jan 27, 2025
@hdamker hdamker self-assigned this Jan 27, 2025
Co-authored-by: Eric Murray <eric.murray@vodafone.com>
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.

LGTM

@hdamker
Copy link
Collaborator Author

hdamker commented Jan 27, 2025

@eric-murray @RandyLevensalor thanks for your reviews. As @jlurien is on vacation I will merge here. There might be some merge conflicts in other PRs afterwards to be resolved.

@hdamker hdamker merged commit 09d5f7a into camaraproject:main Jan 27, 2025
2 checks passed
@hdamker hdamker deleted the 402-replace-terms branch January 27, 2025 16:30
hdamker added a commit to hdamker/QualityOnDemand that referenced this pull request Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation or alignment with commonalities documentation Improvements or additions to documentation Spring25 Issue in scope of Spring25 meta-release cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace terms CSP -> API provider, API invoker -> API Consumer where appropriate
3 participants