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

r1.1 #31

Merged
merged 17 commits into from
Jul 30, 2024
Merged

r1.1 #31

merged 17 commits into from
Jul 30, 2024

Conversation

hdamker
Copy link
Contributor

@hdamker hdamker commented Jul 22, 2024

What type of PR is this?

  • documentation
  • correction of info object in YAML

What this PR does / why we need it:

  • Expanded "SED" into the API name
  • Corrected API Version number and release number in API Checklist
  • Replaced absolute links into main with relative links within the Checklist (they will always point to the right version within a release/tag)
  • Corrections within info object in YAML:
    • Removed contact field
    • Brought license and x-camara-commonalities fields on top level within info object.

Which issue(s) this PR fixes:

none (minor PR)

Special notes for reviewers:

hdamker added 3 commits July 22, 2024 14:09
* Correct API Version and Release number
* Changed absolute links to relative links (relative to repository root)
hdamker added 4 commits July 22, 2024 14:22
Removed contact field
Brought license and x-camara-commonalities fields on top level within info object.
(hopefully done right)
indentation corrected (2. attempt)
All good thing are three ... removing trailing space
@Kevsy Kevsy mentioned this pull request Jul 22, 2024
@Kevsy Kevsy changed the title Minor corrections of API documentation r1.1 Jul 22, 2024
Incorporates changes listed in [SED camaraproject#32](camaraproject#32 (comment))
Kevsy
Kevsy previously approved these changes Jul 24, 2024
Copy link
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

LGTM - awaiting Release Management review and approval before merge to main.

@hdamker hdamker requested a review from a team July 24, 2024 13:09
Changed from 'N' to 'Y' in the 'Previous public release was certified' column, with link to GSMA certification portal.
Confirmed that Enhanced API test cases are included ('rainy day' scenarios)
CHANGELOG.md Outdated
# r0.11.0-rc.1
NOTE: SimpleEdgeDiscovery is part of the EdgeCloud API family, and was previously developed within the [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository. Two releases were made within EdgeCloud, v0.81 and r0.9.3-rc. These releases also include the other EdgeCloud APIs and materials, so the changelog below highlights only the changes related to SimpleEdgeDiscovery. Further information and links to the releases in EdgeCloud can be found below.

# r1.1 - public

Choose a reason for hiding this comment

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

it is not yet public - change public to rc in this header and in the toc item.

Suggest to remove line 20 (disclaimer)

There is no such thing as a public pre-release, hence the line 29 underneath should say "a release-candidate pre-release" iso "an initial public pre-release".

Line 39. suggest to reword as follows: "simple-edge-discovery v0.11.0-rc.1 is a new release-candidate version with significant changes compared to the previous version v0.9.3-rc"

code/API_definitions/simple-edge-discovery.yaml Outdated Show resolved Hide resolved
Kevsy added 5 commits July 26, 2024 09:59
Incorporated Tanja's changes:
- changed 'public' to 'rc' in header and toc item
- line 20 removed  (disclaimer)
- line 29 reworded as 'release candidate pre-release'
- line 39 reworded to 'release candidate'
Per Tanja's review - moved `x-commonalities` beneath `version` field in `info` object
Incorporated Tanja's review feedback
- removed 'EDS'
- 'UE'-> 'device'
- 'terminal' to 'device'
- reworded scope line
- removed 'UNI' line
- 'MEC platform' -> 'Edge Cloud Zone' in diagram
Per Tanja review, updated link to User Story
Removed version number from `Feature` per Tanja's review comment for the API Readiness Checklist
Kevsy
Kevsy previously approved these changes Jul 26, 2024
Copy link
Contributor

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

Tanja's feedback now incorporated - LGTM.

Incorporated Tanja's review:
- included link to pre-releases
Incorporated Tanja's additional comments from issue 32
- Commonalities v0.4-rc.1 -> v0.4.0-rc.1
- SED -> SimpleEdgeDiscovery
@tanjadegroot
Copy link

LGTM - From release mgmt perspective all is OK

please update the API release tracker (and remove there the r1.1 in the public release field :-) ) almost there.

@Kevsy
Copy link
Contributor

Kevsy commented Jul 29, 2024

please update the API release tracker (and remove there the r1.1 in the public release field :-) ) almost there.

Done - thanks Tanja and Herbert.

@javierlozallu Release Management review confirmed (see above), now ready for merge to main.

@Kevsy Kevsy merged commit bc35f15 into camaraproject:main Jul 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants