canonical / canonical/cloud-init
[docs]: new dependency on `nc.openbsd` should be emphasized in the 24.3 release note
- Dominant language
- Python
- Stars
- 3.8k
- Forks
- 1.1k
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 22
Description
# Documentation request
https://github.com/canonical/cloud-init/commit/143bc9e40f7f33695216db60f73e10a900d1d1cd#diff-eb94d50ed1a0a76032438b4bc5bccb389e9cc03d6766d7881463d8ee75f21f8fR25 introduced the dependency on `nc.openbsd`, but this binary is missing by default on several distros such as ArchLinux (https://gitlab.archlinux.org/archlinux/packaging/packages/cloud-init/-/issues/3).
This is a huge breaking change and should be emphasized in the 24.3 release note.
Contributor guide
Research direction
Review commit 143bc9e40f7f33695216db60f73e10a900d1d1cd and locate the 24.3 release note. Verify how the nc.openbsd dependency was introduced and document its absence on distributions such as Arch Linux. Done means the release note clearly highlights this breaking dependency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100