generic fetcher: Add usage docs #718
Open
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
|
/ok-to-test |
|
We also add a tiny introduction of each package manager here: https://github.com/containerbuildsystem/cachi2/blob/main/README.md#package-managers. We should have one for |
kosciCZ
force-pushed
the
generic-fetcher-docs
branch
3 times, most recently
from
e5286c0
to
d8a3f6e
Compare
4 tasks
There was a problem hiding this comment.
This LGTM in the overall.
I think we should split the ADR to a separate commit, or even have it in a separate PR. The reason is that I think we'll merge the docs very quickly, but the ADR also implies making the package manager officially supported, so it'll bring a longer discussion (and we could use the same PR to also remove it from dev-package-managers).
kosciCZ
force-pushed
the
generic-fetcher-docs
branch
from
d8a3f6e
to
097a03d
Compare
This commit adds generic fetcher to the documentation as an experimental package manager, with instructions on usage. Signed-off-by: Jan Koscielniak <[email protected]>
kosciCZ
force-pushed
the
generic-fetcher-docs
branch
from
097a03d
to
0c410e7
Compare
|
I have removed the ADR from this PR and will move it into a separate MR so docs can potentially be merged first. |
4 tasks
kosciCZ
changed the title
|
/ok-to-test |
brunoapimentel
approved these changes
Nov 6, 2024
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.
Add documentation on how to use the generic fetcher and also an ADR to help move out of the experimental phase.
I've tried to follow the CONTRIBUTING.md guidelines, but since I did not see any previous ADR, I just tried to come up with something. Feel free to give more direction on how you want the docs to look like. Thanks!
Maintainers will complete the following section
Note: if the contribution is external (not from an organization member), the CI
pipeline will not run automatically. After verifying that the CI is safe to run:
/ok-to-test(as is the standard for Pipelines as Code)