doc: update autoinstall reference's apt section #2060
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ogayot
reviewed
Aug 23, 2024
|
|
||
| .. code-block:: yaml | ||
|
|
||
| # Use custom mirrors for all architectures. |
There was a problem hiding this comment.
The comment makes it sound like both CUSTOM_MIRROR_* will be used ; while in practice the latter will be used only if the former fails validation. Can we make that clearer somehow?
suggestion:
# Use the first custom mirror that seems to work. Do not restrict to specific architectures.There was a problem hiding this comment.
Yeah, I like your suggestion but with a minor tweak.
# Use the first custom mirror that works. Do not restrict to specific architectures.
|
|
||
| - Subiquity supports an alternative format for the ``primary`` section, allowing configuration of a list of candidate primary mirrors. During installation, Subiquity automatically tests the specified mirrors and selects the first one that appears usable. This new behaviour is only activated when the ``primary`` section is wrapped in the ``mirror-selection`` section. | ||
|
|
||
| - The ``fallback`` key controls what Subiquity does when no primary mirror is usable. | ||
|
|
||
| - The ``geoip`` key controls whether to perform IP-based geolocation to determine the correct country mirror. | ||
|
|
||
| The default is: | ||
|
|
||
| All other sections behave as defined in curtin. See the curtin `documentation <https://curtin.readthedocs.io/en/latest/topics/apt_source.html#common-snippets>`_ and its `example apt configurations <https://git.launchpad.net/curtin/tree/examples/apt-source.yaml>`_ for usage examples of these sections. |
There was a problem hiding this comment.
maybe mention that it covers adding a PPA? I think it's a common use-case and people will be confused if they can't find the example anymore.
There was a problem hiding this comment.
Sure, I think that makes sense. I updated the text a bit, wdyt?
The `primary` sub-section here refers to the `primary` section that is nested under `mirror-selection`. Change this to a sub-section so it also shows up that way in the docs navigator.
Reword the mirror-selection: primary section to be more explicit and to also link to the list of valid mirrors. Also rework all examples of this section to use URI first.
Chris-Peterson444
force-pushed
the
apt-autoinstall-reference-update
branch
from
068b803
to
6fad8c7
Compare
Remove the example for adding a PPA since introducing it in curtin's common snippet's section in [1]. Guide users to the official curtin documentation for examples of curtin specific behavior. [1] https://code.launchpad.net/~cpete/curtin/+git/curtin/+merge/471552
Chris-Peterson444
force-pushed
the
apt-autoinstall-reference-update
branch
from
6fad8c7
to
668456f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
General formatting updates, add example sections for each sub-key, and add links to advanced usage examples in curtin.
Also, because I think the reference here should focus on the parts where Subiquity and Curtin's apt sections differ and not repeating Curtin doc of the section, I removed the "add a PPA" example. I do think it's a good example though, so I opened a PR [1] in Curtin to add it to the common snippet's section.
[1] https://code.launchpad.net/~cpete/curtin/+git/curtin/+merge/471552