canonical / canonical/cloud-init

[docs]: add a minimum viable "getting started" section to the index

Open
#6,533 1 comment 0 reactions 0 assignees View on GitHub
documentation incomplete
Dominant language
Python
Stars
3.8k
Forks
1.1k
Avg merge
2d 23h
Merged PRs (30d)
18

Description

# Documentation request

It would really aid comprehension to provide a minimal usage example, e.g. perhaps something that creates a systemd service.

I envision including a basic `#cloud-config` YAML document + the bare minimum instructions for how it's expected that you get the file onto the box and how you make cloud-init execute it.

Otherwise the reader is left with a huge variety of disparate concepts and it's not clear how they all tie together.

---
*Reported from: https://cloudinit.readthedocs.io/en/latest/index.html*

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.