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

New readiness checklist #43

Merged
merged 6 commits into from
Jul 19, 2024
Merged

Conversation

FabrizioMoggio
Copy link
Collaborator

What type of PR is this?

updating the readiness checklist according to the new format define in Release Management (https://github.com/camaraproject/ReleaseManagement/blob/25400e8f484dbb6e53a7dcc21d3a709b6cc2b686/documentation/API-Readiness-Checklist.md)

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

To be coherent with the readiness checklist

Which issue(s) this PR fixes:

#34

Special notes for reviewers:

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

Let's wait we're aligned on #42 and this one will be good :)

@FabrizioMoggio
Copy link
Collaborator Author

Let's wait we're aligned on #42 and this one will be good :)

you are totally right :-)

- not considering the use cases that are mandatory for the Alpha and still under "refactoring"
- considering merged the changelog PR: camaraproject#58
@FabrizioMoggio FabrizioMoggio requested a review from rartych July 18, 2024 07:37
bigludo7
bigludo7 previously approved these changes Jul 18, 2024
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

We will have to provide links for some of the assets but I guess we can do it later.

@FabrizioMoggio
Copy link
Collaborator Author

We will have to provide links for some of the assets but I guess we can do it later.

once I have produced the release tag we are limited in making change. let me add the links

@rartych
Copy link
Collaborator

rartych commented Jul 18, 2024

We will have to provide links for some of the assets but I guess we can do it later.

We can use relative links, that should work with release tags.
https://github.blog/2013-01-31-relative-links-in-markup-files/

@FabrizioMoggio
Copy link
Collaborator Author

We will have to provide links for some of the assets but I guess we can do it later.

We can use relative links, that should work with release tags. https://github.blog/2013-01-31-relative-links-in-markup-files/

I was thinkig of using the same approach as QoD: https://github.com/camaraproject/QualityOnDemand/blob/main/documentation/API_documentation/quality-on-demand-API-Readiness-Checklist.md

not links but a reference to the path

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM

@FabrizioMoggio FabrizioMoggio merged commit c62fba9 into camaraproject:main Jul 19, 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