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.

Sign up for GitHub

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

Jump to bottom

docs: enhance development setup documentation #76

Merged
merged 2 commits into from
Dec 11, 2024
Merged

docs: enhance development setup documentation #76

merged 2 commits into from
Dec 11, 2024

Conversation

vbelouso
Copy link
Collaborator

  • Improve technical writing style following Red Hat guidelines
  • Restructure content for better readability
  • Add clear section headings and descriptions
  • Update formatting for commands and code blocks
  • Clarify repository structure and build process

@vbelouso
docs: enhance development setup documentation
48bae79 
Signed-off-by: Vladimir Belousov <vbelouso@redhat.com>
@vbelouso vbelouso requested a review from r2dedios December 10, 2024 10:49
@r2dedios r2dedios self-assigned this Dec 10, 2024
@r2dedios r2dedios added the documentation Improvements or additions to documentation label Dec 10, 2024
@r2dedios r2dedios added this to the 0.2 milestone Dec 10, 2024
r2dedios
r2dedios requested changes Dec 10, 2024
View reviewed changes
Copy link
Collaborator

@r2dedios r2dedios left a comment

Choose a reason for hiding this comment

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

Great doc review.

I would add a section for explaining how to generate and update the Swagger documentation

@vbelouso
docs: add API Documentation section
502d3f5 
Signed-off-by: Vladimir Belousov <vbelouso@redhat.com>
@vbelouso
Copy link
Collaborator Author

Great doc review.

I would add a section for explaining how to generate and update the Swagger documentation

Good catch, thanks!

Updated https://github.com/RHEcosystemAppEng/cluster-iq/blob/502d3f53e6ec8db8686367ad024087aadfc9d02b/doc/development-setup.md#api-documentation

@vbelouso vbelouso requested a review from r2dedios December 10, 2024 14:37
r2dedios
r2dedios approved these changes Dec 11, 2024
View reviewed changes
Copy link
Collaborator

@r2dedios r2dedios left a comment

Choose a reason for hiding this comment

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

LGTM

@vbelouso vbelouso merged commit d06a78d into RHEcosystemAppEng:main Dec 11, 2024
@vbelouso vbelouso deleted the dev-guide-fix branch December 11, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@r2dedios r2dedios r2dedios approved these changes

Assignees

@r2dedios r2dedios

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.2
Development

Successfully merging this pull request may close these issues.
2 participants
@vbelouso @r2dedios