canonical/cloud-init

[docs]: The term "module" does not appear to be rigorously defined in the documentation

Open

#4,407 opened on Sep 4, 2023

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Python (1,108 forks)auto 404
documentationgood first issuehacktoberfest

Repository metrics

Stars
 (3,772 stars)
PR merge metrics
 (PR metrics pending)

Description

Documentation request

https://cloudinit.readthedocs.io/en/latest/reference/modules.html

A simple summary might be: "scripts that can be run via configuration options". A reasonable place to provide this definition might be in the "Tutorials" section in an "Overview" sub-section.

Sources that might provide additional input on providing a simple definition:

see: https://cloudinit.readthedocs.io/en/latest/development/module_creation.html https://wiki.archlinux.org/title/Cloud-init#Modules https://www.hashicorp.com/resources/cloudinit-the-good-parts

Contributor guide

Research direction
Review the provided links and existing documentation to understand the concept of modules in cloud init, then draft a definition to be placed in the Tutorials section under an Overview sub section.
Tech stack
python
Domain
clouddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85