docs(eng-11208): Adds format & upstream documentation for Alpine and Wolfi#375
docs(eng-11208): Adds format & upstream documentation for Alpine and Wolfi#375poconnor-cloud wants to merge 6 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
TODO -
|
There was a problem hiding this comment.
As part of the documentation, it's worth verifying that each of the mechanisms being documented works as expected e.g. adding a distribution, the auth mechanisms, etc. The ticket can be used to track that these work using the input + output to avoid adding a bunch of unnecessary context to the PR.
03520ea to
81963df
Compare
81963df to
0a9bfa3
Compare
0a9bfa3 to
8323cc1
Compare
8323cc1 to
5f9c30d
Compare
5f9c30d to
5da85fe
Compare
5da85fe to
8175392
Compare
There was a problem hiding this comment.
Pull request overview
Updates Cloudsmith documentation to clarify Alpine/Wolfi APK usage and adds guidance for configuring Alpine/Wolfi upstream proxying and caching.
Changes:
- Adds Alpine upstream creation guidance and updates the upstreams index to include Alpine.
- Expands Alpine format docs to cover Wolfi, including upload/install instructions and upstream proxying/caching guidance.
- Refactors portions of existing upstream documentation for generic upstream fields and notes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| src/content/repositories/upstreams/index.mdx | Adds Alpine to supported upstream formats and documents how to configure an Alpine/Wolfi upstream. |
| src/content/formats/alpine-repository.mdx | Reworks Alpine format docs to include Wolfi details, updated upload/install flows, and upstream proxying/caching instructions. |
Comments suppressed due to low confidence (1)
src/content/formats/alpine-repository.mdx:255
- The removal instructions delete
/etc/apk/keys/REPOSITORY@cloudsmith-FINGERPRINT.rsa.pub, but earlier setup instructions create/etc/apk/keys/REPOSITORY@OWNER-FINGERPRINT.rsa.pub. This mismatch means the documented cleanup step may not actually remove the installed key.
Remove the cloudsmith repository line, save then execute:
rm -f /etc/apk/keys/REPOSITORY@cloudsmith-FINGERPRINT.rsa.pub
apk update💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f0178fd to
59d6873
Compare
59d6873 to
9bc2a3d
Compare
b9f1f94 to
bf29705
Compare
|
Looks good to me 👍 I paired on part of this and pushed commits so unable to give an approval. Some changes to note: |
ertzL
left a comment
There was a problem hiding this comment.
I've just left too comments on removing the EA banner & adding a screenshot for configuring the upstream - but other than that LGTM!
649da67 to
6721771
Compare
What's Changed
Updated and Added to our Alpine Format Documentation:
co-authored by @apoclyps
relates to: