📖 Fix outdated links in implementers guide #6166
Conversation
k8s-ci-robot
added
cncf-cla: yes
There was a problem hiding this comment.
I plan to create a larger issue around updating the implementers guide in the book. Thanks to @anusha94 @richardcase for giving me some pointers on where it can improve. I'd appreciate your reviews here too if you have the time.
killianmuldoon
force-pushed
the
book/update-providers
branch
from
e9ca40c to
4aba1c2
Compare
killianmuldoon
changed the title
docs/book/src/SUMMARY.md
Outdated
| @@ -71,6 +71,8 @@ | |||
| - [Create API](./developer/providers/implementers-guide/create_api.md) | |||
| - [Controllers and Reconciliation](./developer/providers/implementers-guide/controllers_and_reconciliation.md) | |||
| - [Building, Running, Testing](./developer/providers/implementers-guide/building_running_and_testing.md) | |||
| - [Webhooks](./developer/providers/webhooks.md) | |||
| - [Provider contracts](./developer/providers/contracts.md) | |||
There was a problem hiding this comment.
I know this isn't up to this PR but i really found the menu below Provider implementers confusing
wondering if we can reorg/make things a little bit simpler. some ideas:
- group migration guides
- drop double nesting Provider implementers/Implementer's Guide
- move webhooks aftre API
- move contract somewhere up in the sequence and nest cluster infrastructure, machine infrastructure and bootstrap
There was a problem hiding this comment.
I've done all of this except for dropping the double nesting. I think it's important for the structure right now as the implementers guide is a standalone step-by-step guide.
killianmuldoon
force-pushed
the
book/update-providers
branch
from
4aba1c2 to
0d6f3b8
Compare
k8s-ci-robot
added
size/L
| - [Cluster Infrastructure](./developer/providers/cluster-infrastructure.md) | ||
| - [Machine Infrastructure](./developer/providers/machine-infrastructure.md) | ||
| - [Bootstrap](./developer/providers/bootstrap.md) | ||
| - [Version migration](./developer/providers/version-migration.md) |
There was a problem hiding this comment.
| - [Version migration](./developer/providers/version-migration.md) | |
| - [Migration guides](./developer/providers/version-migration.md) |
nit, if you want (same for the file name)
There was a problem hiding this comment.
I think version migration is clearer and more specific here, but if there's a call to use the more generic title I'll change it.
There was a problem hiding this comment.
Just keep it as is. Version migration just sounded strange to me, but my entire understanding of the english language is subjective :)
There was a problem hiding this comment.
I hope yours is better than mine and you correct the nits I drop on PRs of other folks if they are just too wrong :) (btw :) )
docs/book/src/developer/providers/implementers-guide/generate_crds.md
Outdated
Show resolved
Hide resolved
|
Thx! |
Signed-off-by: killianmuldoon <[email protected]>
killianmuldoon
force-pushed
the
book/update-providers
branch
from
8816520 to
63ccc94
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
@killianmuldoon @fabriziopandini Should we backport? |
|
I don't think so. |
Signed-off-by: killianmuldoon [email protected]
What this PR does / why we need it:
Fixes outdated links in the book, add required information to recent versions of the book and removing references to old book versions.
c/f #6028