canonical/cloud-init

[docs]: Default behaviour of ConfigDrive is unclear

Open

#4,310 opened on Jul 31, 2023

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

Repository metrics

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

Description

Documentation request

https://cloudinit.readthedocs.io/en/latest/reference/datasources/configdrive.html reads:

By default, cloud-init always considers this source to be a fully-fledged datasource. Instead, the typical behavior is to assume it is really only present to provide networking information.

This describes what cloud-init "always" does in opposition to its "typical behaviour", leaving it unclear what cloud-init's actual default behaviour is.

Contributor guide

Research direction
Read the linked documentation and suggest a clearer description of the default behavior.
Tech stack
None
Domain
documentation
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.
90