Skip to content

Conversation

@YadingFang
Copy link
Contributor

@YadingFang YadingFang commented May 6, 2025

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:

  • subproject management

What this PR does / why we need it:

Prepare the release r1.1:

  • Update CHANGELOG.md
  • Update click-to-dial.yaml
  • Set versions in all files

Which issue(s) this PR fixes:

Fixes #33

Special notes for reviewers:

Preparing all files for r1.1 with 0.1.0-alpha.1 versions.
@YadingFang YadingFang requested a review from a team May 6, 2025 04:16
@YadingFang YadingFang added the Fall25 Issue in scope of Fall 25 (or under discussion for it) label May 6, 2025
Copy link
Contributor

@hdamker hdamker left a 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".

Copy link
Contributor

@hdamker hdamker left a 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

Copy link
Contributor

@hdamker hdamker left a 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

@YadingFang
Copy link
Contributor Author

@hdamker, I have made revisions based on your suggestions, thank you!

Copy link
Contributor

@hdamker hdamker left a 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 hdamker self-requested a review May 15, 2025 07:21
Copy link
Contributor

@hdamker hdamker left a 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.

@YadingFang
Copy link
Contributor Author

@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>
Copy link
Contributor

@hdamker hdamker left a 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.

@YadingFang
Copy link
Contributor Author

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.

Copy link
Collaborator

@HanbaiWang HanbaiWang left a comment

Choose a reason for hiding this comment

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

LGTM

@YadingFang YadingFang merged commit a1e85ad into camaraproject:main May 15, 2025
1 check passed
@YadingFang
Copy link
Contributor Author

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.

@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?

@hdamker
Copy link
Contributor

hdamker commented May 23, 2025

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.

@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.

@YadingFang YadingFang added the subproject management Indicating issues with subproject repository or release management process label Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Fall25 Issue in scope of Fall 25 (or under discussion for it) subproject management Indicating issues with subproject repository or release management process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Please create a release PR before creating r1.1 and let it get reviewed by release management team

3 participants