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

README, CHANGELOG and released versions update including Redoc/SwaggerEditor previews #54

Merged
merged 2 commits into from
Aug 25, 2023

Conversation

jpengar
Copy link
Collaborator

@jpengar jpengar commented Aug 10, 2023

What type of PR is this?

Add one of the following kinds:

  • documentation
  • subproject management

What this PR does / why we need it:

Updated the README "Status and released versions" section. It also includes a Redoc preview link, which is more suitable for viewing API definition and documentation in a more visual and friendly way. The link to the API spec file has also been retained.

UPDATE (14/08): CHANGELOG.md and releases information will be updated accordingly as well.

Which issue(s) this PR fixes:

N/A

Special notes for reviewers:

This change is motivated by camaraproject/QualityOnDemand#199. Before MERGE, this PR will be aligned with the final agreement to be reached in the QualityOnDemand project.

Changelog input

N/A

Additional documentation

N/A

Copy link
Collaborator

@fernandopradocabrillo fernandopradocabrillo left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

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

It will be discussed in Commonalities, but it can be helpful to provide also link to Swagger Editor to render the yaml for displaying the documentation: https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml Then the user can choose his preferred on-line tool.

@jpengar
Copy link
Collaborator Author

jpengar commented Aug 14, 2023

It will be discussed in Commonalities, but it can be helpful to provide also link to Swagger Editor to render the yaml for displaying the documentation: https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml Then the user can choose his preferred on-line tool.

I've added the Swagger Editor link in cfa1626. And CHANGELOG.md has been updated as well. In any case, I will wait for final agreement in Commonalities to do the same. Eventually the releases should also be updated with the same info as CHANGELOG.md.

@jpengar jpengar requested a review from rartych August 14, 2023 08:32
Copy link
Collaborator

@rartych rartych left a comment

Choose a reason for hiding this comment

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

LGTM

@jpengar jpengar changed the title README - status and released versions update including Redoc preview link README, CHANGELOG and released versions update including Redoc/SwaggerEditor previews Aug 14, 2023
@jpengar jpengar merged commit 3b263fd into main Aug 25, 2023
@jpengar jpengar deleted the jpengar/update-readme-redoc-preview-link branch August 25, 2023 11:50
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.

3 participants