docs: confusing heading "Add apt repositories"

Bug #1832823 reported by Jonas Rinner
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Fix Released
Low
Unassigned

Bug Description

While reading the docs and learning cloud-init for the first time, I noticed that "Add apt repositories" in the "Cloud config examples" section actually describes how to set the default apt mirror.

This was confusing to me, as I was looking for a way to add third-party repositories, which isn't shown in that example; I thought it wasn't even possible to add third-party repos until I scrolled down to "Additional apt configuration", where the way to do that is actually described.

I don't know if it's just me, but I was a bit confused by this. Maybe you could consider changing that heading to something like "Select apt mirrors".

Relevant lines:
https://git.launchpad.net/cloud-init/tree/doc/rtd/topics/examples.rst#n63
https://git.launchpad.net/cloud-init/tree/doc/examples/cloud-config-add-apt-repos.txt#n3

Tags: docs
Revision history for this message
Dan Watkins (oddbloke) wrote :

Hi Jonas,

Thanks for spotting this problem and taking the time to file this bug! Would this be a fix you would be interested in contributing?

(If so, please follow the steps at https://cloudinit.readthedocs.io/en/latest/topics/hacking.html!)

Thanks!

Dan

Changed in cloud-init:
status: New → Triaged
importance: Undecided → Low
do3meli (d-info-e)
tags: added: docs
Revision history for this message
Joshua Powers (powersj) wrote :
Joshua Powers (powersj)
Changed in cloud-init:
status: Triaged → Fix Committed
Revision history for this message
Chad Smith (chad.smith) wrote : Fixed in cloud-init version 19.4.

This bug is believed to be fixed in cloud-init in version 19.4. If this is still a problem for you, please make a comment and set the state back to New

Thank you.

Changed in cloud-init:
status: Fix Committed → Fix Released
Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.