canonical/cloud-init

docs: update rtd documentation for altcloud

Open

#3,968 opened on May 12, 2023

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

Repository metrics

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

Description

This bug was originally filed in Launchpad as LP: #1968789

Launchpad user Chad Smith(chad.smith) wrote on 2022-04-12T20:46:24.022823+00:00

Update "read the docs" content at doc/rtd/topics/datasources/altcloud.rst

Ensure it correctly represents behavior and configuration options as used in: cloudinit/sources/DataSourceAltCloud.py

Example format/style should be something like:

doc/rtd/topics/datasources/ec2.rst

Specifically, these docs need to also include discussion of seed directory setup in /var/lib/cloud/seed/*.

Contributor guide

Research direction
Review the existing altcloud datasource source code and the ec2 documentation example. Update doc/rtd/topics/datasources/altcloud.rst to match the current behavior and configuration options. Include discussion of seed directory setup.
Tech stack
python
Domain
backend
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90