Clean up README, add supported distros page to docs. #2162
Conversation
There was a problem hiding this comment.
Approve after this changeset and @s-makin's review/thoughts.
@holmanb @s-makin do we think this makes cloud-init support matrix less visible in terms of new-developer adoption when looking for where cloud-init can run?
diff --git a/doc/rtd/reference/datasources.rst b/doc/rtd/reference/datasources.rst
index 36f8372bc..04568001e 100644
--- a/doc/rtd/reference/datasources.rst
+++ b/doc/rtd/reference/datasources.rst
@@ -28,6 +28,8 @@ exceptions, one can override datasource detection either by configuring a
single datasource in the :ref:`datasource_list<base_config_datasource_list>`,
or by using :ref:`kernel commandline arguments<kernel_datasource_override>`.
+.. _datasources_supported:
+
Datasources:
============
diff --git a/doc/rtd/reference/distros.rst b/doc/rtd/reference/distros.rst
index e5fd90391..d3be949a2 100644
--- a/doc/rtd/reference/distros.rst
+++ b/doc/rtd/reference/distros.rst
@@ -30,6 +30,6 @@ Supported distros
.. note::
- While BSD variants are not typically refered to as "distributions",
+ While BSD variants are not typically referred to as "distributions",
cloud-init has an abstraction for operating system differences, which
should be contained in `cloudinit/distros/ <https://github.com/canonical/cloud-init/tree/main/cloudinit/distros>`_.
README.md
Outdated
| | Supported OSes | Supported Public Clouds | Supported Private Clouds | | ||
| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- | | ||
| | Alpine Linux<br />Arch Linux<br />Container-Optimized OS<br />Debian<br />DragonFlyBSD<br />Fedora<br />FreeBSD<br />Gentoo Linux<br />NetBSD<br />OpenBSD<br />openEuler<br />OpenCloudOS<br />OpenMandriva<br />RHEL/CentOS/AlmaLinux/Rocky/PhotonOS/Virtuozzo/EuroLinux/CloudLinux/MIRACLE LINUX/MarinerOS<br />SLES/openSUSE<br />TencentOS<br />Ubuntu<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /> | Amazon Web Services<br />Microsoft Azure<br />Google Cloud Platform<br />Oracle Cloud Infrastructure<br />Softlayer<br />Rackspace Public Cloud<br />IBM Cloud<br />DigitalOcean<br />Bigstep<br />Hetzner<br />Joyent<br />CloudSigma<br />Alibaba Cloud<br />Huawei Cloud<br />OVH<br />OpenNebula<br />Exoscale<br />Scaleway<br />CloudStack<br />AltCloud<br />SmartOS<br />HyperOne<br />Vultr<br />Rootbox<br /> | Bare metal installs<br />OpenStack<br />LXD<br />KVM<br />Metal-as-a-Service (MAAS)<br />VMware<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br />| | ||
| The majority of [clouds](https://cloudinit.readthedocs.io/en/latest/reference/datasources.html#id2) |
There was a problem hiding this comment.
I think we want to avoid linking to an automatically generated link id because we'll end up unintentionally breaking this link in the future when we restructure the datasource.rst structure
There was a problem hiding this comment.
does rst allow creating named anchors?
There was a problem hiding this comment.
does rst allow creating named anchors?
Yes, which I've now added:
.. _datasources_supported:
There was a problem hiding this comment.
I'd also prefer for us to link to the page as a relative link rather than a hard-coded reference to the rtd.io page
Co-authored-by: Chad Smith <chad.smith@canonical.com>
README.md
Outdated
| | Supported OSes | Supported Public Clouds | Supported Private Clouds | | ||
| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- | | ||
| | Alpine Linux<br />Arch Linux<br />Container-Optimized OS<br />Debian<br />DragonFlyBSD<br />Fedora<br />FreeBSD<br />Gentoo Linux<br />NetBSD<br />OpenBSD<br />openEuler<br />OpenCloudOS<br />OpenMandriva<br />RHEL/CentOS/AlmaLinux/Rocky/PhotonOS/Virtuozzo/EuroLinux/CloudLinux/MIRACLE LINUX/MarinerOS<br />SLES/openSUSE<br />TencentOS<br />Ubuntu<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /> | Amazon Web Services<br />Microsoft Azure<br />Google Cloud Platform<br />Oracle Cloud Infrastructure<br />Softlayer<br />Rackspace Public Cloud<br />IBM Cloud<br />DigitalOcean<br />Bigstep<br />Hetzner<br />Joyent<br />CloudSigma<br />Alibaba Cloud<br />Huawei Cloud<br />OVH<br />OpenNebula<br />Exoscale<br />Scaleway<br />CloudStack<br />AltCloud<br />SmartOS<br />HyperOne<br />Vultr<br />Rootbox<br /> | Bare metal installs<br />OpenStack<br />LXD<br />KVM<br />Metal-as-a-Service (MAAS)<br />VMware<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br />| | ||
| The majority of [clouds](https://cloudinit.readthedocs.io/en/latest/reference/datasources.html#id2) |
There was a problem hiding this comment.
does rst allow creating named anchors?
|
Sally, I had thought about wondered that initially too. But because this is
the project README.md in our source tree it's not hosted as part of
readthedocs content. So, the URL from here can't really point locally
besides source rst files for distros.rst of datasources.rst. I'm not
certain if there is a better way because linking to the local/relative RST
files looks something like this which is probably not ideal.
https://github.com/canonical/cloud-init/blob/main/doc/rtd/reference/datasources.rst
Though I recognize it's also probably not ideal to link external in case we
change where rendered RTD content is in the future as well.
…On Thu, May 4, 2023 at 2:56 PM s-makin ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In README.md
<#2162 (comment)>
:
> +The majority of [clouds](https://cloudinit.readthedocs.io/en/latest/reference/datasources.html#datasources_supported)
+and [Linux / Unix OSes](https://cloudinit.readthedocs.io/en/latest/reference/distros.html)
Can we change these to be internal page references rather than hardcoded
URLs?
—
Reply to this email directly, view it on GitHub
<#2162 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADLZJRRAYRSKNYKPLK6IU7DXEORQTANCNFSM6AAAAAAXUAI6PA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
That's a fair point. I've retracted my request - it just means we'll have to remember to update these links once the migration completes. |
Welcome! |
Additional Context
The markdown table is ugly, make the README less so.