summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoshua Powers <josh.powers@canonical.com>2019-12-04 11:03:24 -0800
committerGitHub <noreply@github.com>2019-12-04 11:03:24 -0800
commitf64faaedb277fec42006597d2c21b3f8b99d5b87 (patch)
tree49c7b9423714bddc72b53c8203c77191804044af /README.md
parent8c826821295cfc7d9292321b73c8bd461dbeee62 (diff)
downloadcloud-init-git-f64faaedb277fec42006597d2c21b3f8b99d5b87.tar.gz
doc: Updates to wording of README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 17 insertions, 22 deletions
diff --git a/README.md b/README.md
index 9e47b286..bb9cf0d0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-# Cloud-init official project upstream as of 11/2019
-This repository is also mirrored to https://launchpad.net/cloud-init
+# cloud-init
[![Build Status](https://travis-ci.org/canonical/cloud-init.svg?branch=master)](https://travis-ci.org/canonical/cloud-init) [![Read the Docs](https://readthedocs.org/projects/cloudinit/badge/?version=latest&style=flat)](https://cloudinit.readthedocs.org)
@@ -21,40 +20,36 @@ access key and many other aspects of a system. Later on the cloud-init will
also parse and process any optional user or vendor data that was passed to the
instance.
-## Getting involved
-All contributions welcome! [Submit code and docs by following our hacking guide](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html)
-
## Getting help
-Having trouble? We would like to help!
+If you need support, start with the [user documentation](https://cloudinit.readthedocs.io/en/latest/).
+
+If you need additional help consider reaching out with one of the following options:
- Ask a question in the [``#cloud-init`` IRC channel on Freenode](https://webchat.freenode.net/?channel=#cloud-init)
- Join and ask questions on the [cloud-init mailing list](https://launchpad.net/~cloud-init)
- Find a bug? [Report bugs on Launchpad](https://bugs.launchpad.net/cloud-init)
-## Recent cloud-init upstream releases
-Upstream release version | Release date |
---- | --- |
-19.4 | planned (2019-12-XX) |
-[19.3](https://launchpad.net/cloud-init/+milestone/19.3) | 2019-11-05 |
-[19.2](https://launchpad.net/cloud-init/+milestone/19.2) | 2019-07-17 |
-[19.1](https://launchpad.net/cloud-init/+milestone/19.1) | 2019-05-10 |
+## Distribution and cloud support
-
-## Cloud-init distribution and cloud support
-Note: Each linux distribution and cloud tracks cloud-init upstream updates at
-a different pace. If your distribution or cloud doesn't contain a recent
-cloud-init, suggest or propose an upgrade with your distribution of choice.
+Below are a list of the many OSes and clouds that contain and ship with cloud-init. If your
+distribution or cloud is not listed or does not have a recent version of cloud-init, please
+get in contact with that distribution and send them our way!
| Supported OSes | Supported Public Clouds | Supported Private Clouds |
| --- | --- | --- |
| Ubuntu<br />SLES/openSUSE<br />RHEL/CentOS<br />Fedora<br />Gentoo Linux<br />Debian<br />ArchLinux<br />FreeBSD<br /><br /><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 />Digital Ocean<br />Bigstep<br />Hetzner<br />Joyent<br />CloudSigma<br />Alibaba Cloud<br />OVH<br />OpenNebula<br />Exoscale<br />Scaleway<br />CloudStack<br />AltCloud<br />SmartOS<br /> | Bare metal installs<br />OpenStack<br />LXD<br />KVM<br />Metal-as-a-Service (MAAS)<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br />|
+## To start developing cloud-init
+
+Checkout the [hacking](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html)
+document that outlines the steps necessary to develop, test, and submit code.
-## Daily Package Builds
-We host daily [Ubuntu Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes) that build package for each Ubuntu series from tip of cloud-init.
+## Daily builds
-For CentOS 7/8 we publish to a couple of COPR build repos:
+Daily builds are useful if you want to try the latest upstream code for the latest
+features or to verify bug fixes.
- * [**cloud-init-dev**: daily builds from cloud-init tip](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/)
+For Ubuntu, see the [Daily PPAs](https://code.launchpad.net/~cloud-init-dev/+recipes).
+For CentOS, see the [COPR build repos](https://copr.fedorainfracloud.org/coprs/g/cloud-init/cloud-init-dev/)