doc: initial repository blurb #379
Conversation
supakeen
force-pushed
the
repository-documentation
branch
11 times, most recently
from
8361d2b to
4f94477
Compare
| For more information on the format and available options see the [managing repositories](https://osbuild.org/docs/on-premises/installation/managing-repositories/) page. | ||
|
|
||
| ## `force-repo` / `extra-repo` | ||
|
|
There was a problem hiding this comment.
I think this needs a separate paragraph making it clear this overrides repos for all distributions. You mention it in the example, but that could be missed.
There was a problem hiding this comment.
I've added a blurb to say that it is up to the user to make sure that the given repositories are correct for the distribution they are wanting to build.
achilleas-k
left a comment
achilleas-k
left a comment
There was a problem hiding this comment.
LGTM. Some minor comments, but ok to ignore or address separately.
doc/20-advanced/10-repositories.md
Outdated
| @@ -0,0 +1,103 @@ | |||
| # Repository Management | |||
|
|
|||
| When building package based images `image-builder` will use repositories to get packages from. `image-builder` ships with built-in definitions and repositories for a [list of distributions](../10-faq.md#built-in-distributions). These are used when building artifacts. | |||
There was a problem hiding this comment.
Bit of an awkward sentence structure here ("... to get the packages from.").
How about:
When building package-based images,
image-builderdownloads packages from pre-defined repositories.
doc/20-advanced/10-repositories.md
Outdated
|
|
||
| When building package based images `image-builder` will use repositories to get packages from. `image-builder` ships with built-in definitions and repositories for a [list of distributions](../10-faq.md#built-in-distributions). These are used when building artifacts. | ||
|
|
||
| A common request is to enable additional repositories, override the repositories used, redirect repositories, or include additional repositories in the produced artifact. For this we need to go through the way `image-builder` uses repositories for each step of the build process. |
There was a problem hiding this comment.
I'd replace "request" with "requirement".
doc/20-advanced/10-repositories.md
Outdated
| $ sudo image-builder build --distro fedora-43 --force-repo https://some/base/url minimal-raw-xz | ||
| ``` | ||
|
|
||
| `force-repo` can be passed multiple times. When this is done all `force-repo` repositories are used but no built in repositories. |
There was a problem hiding this comment.
The word "passed" is used a lot in this section. Let's reduce the number a bit and instead say "can be used multiple times" (or maybe "specified", if you prefer).
There was a problem hiding this comment.
I've replaced some with "given", and some with "can be used". Large reduction in the use of passed :)
supakeen
force-pushed
the
repository-documentation
branch
2 times, most recently
from
175d9b8 to
0020c06
Compare
After a chat in our community Matrix channel I realized that we have not documented the various ways of managing repositories in `image-builder`. Let's start that off with a small initial page that I will build on in the following commits. This relies on the implementation of the new `force-repo-dir` behavior as that's the behavior documented [1]. [1]: osbuild#408 Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
supakeen
force-pushed
the
repository-documentation
branch
from
0020c06 to
c733f81
Compare
With the potential to use YAML for repository file formats let's make sure it's the advertised way [1]. [1]: osbuild/images#2095 Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
3 participants
After a chat in our community Matrix channel I realized that we have not documented the various ways of managing repositories in
image-builder. Let's start that off with a small initial page that I will build on in the following commits.