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

Reference docs updates #55

Merged
merged 2 commits into from
Mar 1, 2024

Conversation

jasonmadigan
Copy link
Member

Some updates to the reference docs, prior to inclusion as a component on our docs website.

See #52

@jasonmadigan jasonmadigan force-pushed the 52-kuadrantctl-ref-docs branch 2 times, most recently from 7b39eb1 to c46dc51 Compare March 1, 2024 10:46
@R-Lawton
Copy link
Contributor

R-Lawton commented Mar 1, 2024

👀

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@jasonmadigan
Copy link
Member Author

jasonmadigan commented Mar 1, 2024

Copy of mkdocs rendered content in this draft PR for docs:

Kuadrant/docs.kuadrant.io#77

@R-Lawton ^ added a screenshot in that draft PR in case you want to see the rendered content without having to checkout locally.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.38%. Comparing base (0658b51) to head (47f6c18).

Additional details and impacted files
@@          Coverage Diff          @@
##            main     #55   +/-   ##
=====================================
  Coverage   0.38%   0.38%           
=====================================
  Files         17      17           
  Lines        783     783           
=====================================
  Hits           3       3           
  Misses       780     780           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@david-martin david-martin left a comment

Choose a reason for hiding this comment

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

/lgtm

Out of interest, are the command overview tables generated from the cli or the help output?
Thinking how they'd be most easily updated in future

Copy link
Collaborator

@eguzki eguzki left a comment

Choose a reason for hiding this comment

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

🥇

@R-Lawton
Copy link
Contributor

R-Lawton commented Mar 1, 2024

lgtm

@R-Lawton R-Lawton merged commit e62ea71 into Kuadrant:main Mar 1, 2024
5 checks 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.

None yet

5 participants