docs: describe operational readiness #12723
Merged
Conversation
This file contains hidden or 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
9 tasks
johnstcn
reviewed
Mar 22, 2024
| 1. Incorporate [support links](../appearance.md#support-links) into internal | ||
| documentation accessible from the user context menu. Ensure that hyperlinks | ||
| are valid and lead to up-to-date materials. | ||
| 1. Encourage the use of `coder support bundle` to allow workspace users to |
There was a problem hiding this comment.
coder support bundle can only be used by administrators -- additionally, the command is currently hidden and will be un-hidden closer to the next release.
There was a problem hiding this comment.
I guess that this is coming now 👍
693dbe2 to
d8c5708
Compare
johnstcn
approved these changes
Mar 25, 2024
Comment on lines
+205
to
+207
| # no `-j` flag as `make` fails with: | ||
| # coderd/rbac/object_gen.go:1:1: syntax error: package statement must be first | ||
| run: "make --output-sync -B gen" |
There was a problem hiding this comment.
👍 I think this is fine for now but ideally we should figure out why this happens. Maybe file a follow-up issue?
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.
Fixes: #12426
This PR extends Reference Architectures with a paragraph about the operational readiness of Coder deployment. Feel free to add more ideas to the checklist.
Extra changes:
make genandmake build/coder_docs.... It fails withcoderd/rbac/object_gen.go:1:1: syntax error: package statement must be first.