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

docs: add numbering and headers for navigation, minor edits #84

Merged
merged 1 commit into from
May 31, 2024

Conversation

smccarthy-ie
Copy link
Contributor

Adding numbered headings to help keep track of where you are in procedures, more headings to break up text, and minor copy edits only. No changes to technical content.

Please cherry pick to v0.7 also. Thanks

@smccarthy-ie
Copy link
Contributor Author

smccarthy-ie commented May 31, 2024

@david-martin When you get a chance, can you review/merge this one? Nothing too controversial here. Mostly minor edits to improve readability and style :) Thanks!

@david-martin
Copy link
Contributor

david-martin commented May 31, 2024

Thanks @smccarthy-ie

@jasonmadigan We're mid 0.8 release right now.
Thoughts on backporting to 0.7 as well? (I've no issue with it per-se. The process is something I'd need a steer on with the mike plugin for mkdocs)

@david-martin david-martin merged commit 10ae41b into Kuadrant:main May 31, 2024
5 checks passed
@jasonmadigan
Copy link
Member

@david-martin no issue with that - it would need a backport and a re-deploy of the 0.7.x docs. Basically:

@jasonmadigan
Copy link
Member

If you need help with the cherry-pick just shout

@david-martin
Copy link
Contributor

david-martin commented Jun 5, 2024

cherrypick 86a0d35
workflow
https://github.com/Kuadrant/docs.kuadrant.io/actions/runs/9382180094

Changes look correct at a glance https://docs.kuadrant.io/0.7.0/kuadrantctl/doc/openapi-apicurio/

@smccarthy-ie
Copy link
Contributor Author

Looks great, thanks @david-martin @jasonmadigan

@smccarthy-ie smccarthy-ie deleted the oas-ext-doc-edits branch June 5, 2024 10:30
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