-
Notifications
You must be signed in to change notification settings - Fork 8
Release r1.1 with 0.1.0-alpha.1 #34
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
Conversation
Preparing all files for r1.1 with 0.1.0-alpha.1 versions.
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments. They don't need necessarily be addressed for an alpha release, you can alternatively set the lines 2 and 3 within the readiness checklist to "N".
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please touch the README.md of the repository and uncomment the line
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please delete the "README.md" placeholder files in API_definitions and API_documention
|
@hdamker, I have made revisions based on your suggestions, thank you! |
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@YadingFang We are getting there ... thanks for addressing my previous comments. Please find a few new ones.
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accidentally approved previously.
See the above comments. Some of them should be addressed before the release.
|
@hdamker, I‘ve finished the revisions based on your recent comments. Please take a moment to review them. |
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will stop here to dig into more details, as an alpha version it looks good to me.
Going forward you might want to revisit documentation/API_documentation/click-to-dial_API.md ... it's not in line with the API anymore and a lot of the information could be embedded into the API definition (where it will be available directly together with the API definition within tools like Swagger or Redoc). Examples how to use the API might be still valuable within the doc file.
Thanks, we'll work on it in the next release version. Now I'll put it into a new issue first. |
HanbaiWang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@hdamker, one more question, if we put the important information from /API_documentation/click-to-dial_API.md into /API_definitions/click-to-dial.yaml, can we delete /API_documentation/click-to-dial_API.md, or should we update it to match the /API_definitions/click-to-dial.yaml file? |
@YadingFang there shouldn't be duplication of documentation, so if all information fits from the click-to-dial_API.md fits into the YAML, then you can delete it. The practice has shown that the risk of outdated documentation is much lower if it stays within the YAML. But if there is supplementary information left (e.g. a tutorial how to use the API or other background documentation) you can as well keep it. |
Preparing all files for r1.1 with 0.1.0-alpha.1 versions.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Prepare the release r1.1:
Which issue(s) this PR fixes:
Fixes #33
Special notes for reviewers: