canonical
[docs]: some DataSources missing from docs
Documentation request
The list of DataSource on RTD page https://cloudinit.readthedocs.io/en/latest/reference/datasources.html is missing some DataSources including Bigstep, Hetzner, and IBM Cloud.
Thank you @dermotbradley for filing this issue an improving cloud-init. We originally filed a number of documentation bugs per missing datasource and closed them last year given limited traction/movement on those bugs:
https://github.com/canonical/cloud-init/issues?q=is%3Aopen+label%3A%22good+first+issue%22++label%3Adocumentation I think we may have some community documentation work lined up for Fall 2024 that may make this actionable broadly by community members looking to level up on doc improvements for this project.
Ideally we'd have documentation format aligned with something like:
doc/rtd/topics/datasources/ec2.rst
A brief description of the datasource, maybe an external link to any datasource third-party/vendor documentation and the minimum configuration options supported by cloud-init. If someone feels inspired to grab this content it would be helpful and we can provide assistance in the generation and review of these docs pull requests
Per the issue any of the following datasources can be worked and we can file a separate issue to track them if necessary:
- BigStep
- Hetzner
- IBMCloud
- MAAS
Hi @blackboxsw and @dermotbradley ! I’ve opened a PR to address this issue.
The PR adds the missing documentation pages for the Bigstep, Hetzner, and IBMCloud datasources under doc/rtd/reference/datasources/, and updates the datasources.rst toctree so they appear correctly on the rendered datasources index on ReadTheDocs.
PR: https://github.com/canonical/cloud-init/pull/6580
Summary: Added bigstep.rst, hetzner.rst, and ibmcloud.rst Updated the datasources toctree to include these entries Ensures all supported datasources listed in datasource_dsname_map are now discoverable from the RTD datasource index
Happy to update anything if needed!
