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]: autogen network documentation #5813

Open
holmanb opened this issue Oct 10, 2024 · 0 comments
Open

[docs]: autogen network documentation #5813

holmanb opened this issue Oct 10, 2024 · 0 comments
Labels
documentation This Pull Request changes documentation new An issue that still needs triage

Comments

@holmanb
Copy link
Member

holmanb commented Oct 10, 2024

Documentation request

Cloud-init's network configuration is manually written[1][2]. Cloud-init recently added schema for validating network configuration[3][4], following the cloud-init's cloud-config validation model[5]. Cloud-config benefits from auto-generated documentation, which keeps documentation in sync with cloud-init's behavior. It would be nice if cloud-init's network documentation was also auto-generated from the schema.

[1] https://github.com/canonical/cloud-init/blob/main/doc/rtd/reference/network-config-format-v1.rst
[2] https://github.com/canonical/cloud-init/blob/main/doc/rtd/reference/network-config-format-v2.rst
[3] https://github.com/canonical/cloud-init/blob/main/cloudinit/config/schemas/schema-network-config-v1.json
[4] https://github.com/canonical/cloud-init/blob/main/cloudinit/config/schemas/schema-network-config-v2.json
[5] https://github.com/canonical/cloud-init/blob/main/cloudinit/config/schemas/schema-cloud-config-v1.json
[6] https://github.com/canonical/cloud-init/blob/main/doc/rtd/reference/modules.rst

@holmanb holmanb added documentation This Pull Request changes documentation new An issue that still needs triage labels Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This Pull Request changes documentation new An issue that still needs triage
Projects
None yet
Development

No branches or pull requests

1 participant