Document Network Configurators #363
Conversation
Signed-off-by: Andrea Mazzotti <[email protected]>
✅ Deploy Preview for elemental-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Andrea Mazzotti <[email protected]>
|
@fgiudici I initially went with 3 subpages for nmc, nmstate, and nmconnections, but I ended up adding the three options with a sample config for each as a 3 different tabs in the networking page. Makes me feel the networking page is quite vast, but I find it still manageable. If you think otherwise let me know and I can split it in subpages. |
Signed-off-by: Andrea Mazzotti <[email protected]>
I like more the tabs 👍🏼 |
Signed-off-by: Andrea Mazzotti <[email protected]>
There was a problem hiding this comment.
There are a lot of examples, which I think the users will like a lot, well done!
We present all together (declarative networking + IPAM + examples) which while it is how it is implemented and how should be used, it could be harder to follow for a user not used to IPAM and declarative networking.
May be more easy to follow if we introduce first declarative networking (without IPAM), present the generators and after that we cover IPAM.
Ideally main page would be an overview of all the pieces and different subpages would cover the details for declarative network and for IPAM. Moreover, subpages with nothing more than ready to use network configuration examples would be handy, covering also complex network configurations (e.g., teams, bonds, bridges, vlans, ...).
So, guess we need a new EPIC to track the documentation effort of the declarative networking 😆
Regarding this PR, it is a pretty nice initial coverage of the feature, please merge it asap! 🚀 🎉
Signed-off-by: Andrea Mazzotti <[email protected]>
Documentation for rancher/elemental-operator#819