docs: clarify coder_metadata usage
#267
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
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @ethanndickson and the rest of your teammates on |
ethanndickson
force-pushed
the
08-14-docs_clarify_coder_metadata_usage
branch
from
19dd470 to
38546ea
Compare
ethanndickson
force-pushed
the
08-14-docs_clarify_coder_metadata_usage
branch
2 times, most recently
from
ff7aabf to
97e4fb5
Compare
ethanndickson
force-pushed
the
08-14-docs_clarify_coder_metadata_usage
branch
from
97e4fb5 to
ca52f1f
Compare
|
Important We should backport this to Also, I renamed the |
matifali
approved these changes
Aug 28, 2024
There was a problem hiding this comment.
@ethanndickson @stirby can you backport this to release branch too? And then we can push a new tag.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The
coder_metadataresource is only used to apply metadata to specific template resources. To apply metadata at the workspace level, and have it be shown on the main workspace pane, ametadatablock needs to be created on thecoder_agentresource. Alternatively, anycoder_metadataattached to the resource containing the agent will be shown on the dashboard by default (see our dogfood template), but this isn't super obvious, so we'll add a comment.It's pretty easy to assume that the
coder_metadataresource would let you apply workspace metadata, if you associated it with the agent, so we'll also add a comment mentioning this isn't the case.