First pass at rewriting the tokens/API section. #1732
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
Signed-off-by: Max Allan <max.allan@chainguard.dev>
Signed-off-by: Max Allan <max.allan@chainguard.dev>
Signed-off-by: Max Allan <max.allan@chainguard.dev>
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
amouat
approved these changes
Aug 1, 2024
| ``` | ||
|
|
||
| To make sure your token is set, you can run the following command: | ||
| You may use the `crane` tool to get your token instead: |
There was a problem hiding this comment.
| ``` | ||
| Where `ORGANIZATION_NAME` is the name of your organization, for example: `company.com`, `IMAGE_NAME` is the name of the image, for example: `chainguard-base` (Note: the image name specified here does not need to be the same image you pass to the API later! But it needs to be a valid image from your registry.) |
There was a problem hiding this comment.
A little confusing.
Maybe:
Replace
ORGANIZATION_NAMEandIMAGE_NAMEas required. For example, if your organization isfoo.comand you're interested in thechainguard-baseimage:auth_header="$(crane auth token -H cgr.dev/foo.com/chainguard-base)"
I'm not sure if it's worth mentioning matching image names, just in case it changes.
|
There's still a section at the bottom on "enterprise images". I'm not sure if that also needs updated or if we can just delete. Let's not let it get in the way of this fix though. |
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.
Signed-off-by: Max Allan max.allan@chainguard.dev
Type of change
Documentation change
What should this PR do?
Fixes some incorrect content on how to get a token.
Why are we making this change?
The suggested method to get a token for private images was incorrect.
What are the acceptance criteria?
Review by docs team.
How should this PR be tested?
Try out the commands proposed.