Kuadrant / kuadrantctl

Kuadrant configuration command line utility
Apache License 2.0
6 stars 12 forks source link

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

Closed smccarthy-ie closed 1 month ago

smccarthy-ie commented 1 month ago

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 commented 1 month ago

@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 commented 1 month ago

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)

jasonmadigan commented 1 month ago

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

jasonmadigan commented 1 month ago

If you need help with the cherry-pick just shout

david-martin commented 1 month ago

cherrypick https://github.com/Kuadrant/kuadrantctl/commit/86a0d35445a58b564949aceddb9d080befbdd5ec 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 commented 1 month ago

Looks great, thanks @david-martin @jasonmadigan