yahoo-eng-team team mailing list archive

[Jonas Rinner <1832823@xxxxxxxxxxxxxxxxxx>]

Public bug reported:

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

** Affects: cloud-init
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to cloud-init.
https://bugs.launchpad.net/bugs/1832823

Title:
  docs: confusing heading "Add apt repositories"

Status in cloud-init:
  New

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-init/+bug/1832823/+subscriptions