docs: add new best practice doc to speed up templates and workspaces #15296
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
matifali
reviewed
Oct 31, 2024
matifali
reviewed
Oct 31, 2024
johnstcn
reviewed
Oct 31, 2024
Co-authored-by: Muhammad Atif Ali <atif@coder.com>
EdwardAngert
commented
Oct 31, 2024
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
bpmct
reviewed
Oct 31, 2024
stirby
requested changes
Oct 31, 2024
| metrics are a part of the Helm chart?] | ||
|
|
||
| Visit the | ||
| [observability repository](https://github.com/coder/observability?tab=readme-ov-file#installation) |
There was a problem hiding this comment.
We reccommend that all administrators deploying on Kubernetes set the observability bundle up with the control plane from the start. For installation instructions, you can visit the [observability repository](https://github.com/coder/observability?tab=readme-ov-file#installation), or our [Kubernetes installation guide](../../install/kubernetes.md).
There was a problem hiding this comment.
I'm into this + we should add it to the kubernetes doc
which, aside, something looks busted here. Can I tweak the MD? commit incoming
There was a problem hiding this comment.
I believe the observability bundle used to be in the k8s install docs. Unsure where it went :(
Yeah, if you want to fix the numbers, go for it. This is definitely an annoyance in our parser.
There was a problem hiding this comment.
-
-
and as a separate commit(for easy reverting if we need), I added a slightly tweaked version of your suggested text to the k8s install doc (preview).
-
on ✅ ?
johnstcn
reviewed
Oct 31, 2024
EdwardAngert
commented
Oct 31, 2024
EdwardAngert
commented
Oct 31, 2024
EdwardAngert
commented
Oct 31, 2024
johnstcn
approved these changes
Oct 31, 2024
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.
closes #14858
build-timeline.pngBest practicesdoesn't show up in the sidebar until you're actually in the doc 🤔preview