NotificationsYou must be signed in to change notification settings
Fork927
Star10.1k

docs: add new best practice doc to speed up templates and workspaces#15296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

EdwardAngert merged 22 commits intomainfrombp-speed-up-templates

Nov 1, 2024

Merged

docs: add new best practice doc to speed up templates and workspaces#15296

EdwardAngert merged 22 commits intomainfrombp-speed-up-templates

Nov 1, 2024

Conversation

Copy link

Contributor

EdwardAngert commentedOct 30, 2024•
edited
Loading

closes#14858

TODO: updatebuild-timeline.png
TODO:Best practices doesn't show up in the sidebar until you're actually in the doc 🤔

preview

speed up templates and workspaces

3886e0b

EdwardAngert added the docsArea: coder.com/docs label

Oct 30, 2024

EdwardAngert self-assigned this

Oct 30, 2024

EdwardAngert added2 commits

October 30, 2024 15:46

update screenshot

4a42588

make fmt

3073ab7

EdwardAngert requested review fromjohnstcn,dak1001,bpmct andstirby

October 30, 2024 20:00

EdwardAngert added2 commits

October 30, 2024 20:38

add speed up to manifest

30417eb

add index to best practices

2df6c0b

Copy link

ContributorAuthor

EdwardAngert commentedOct 30, 2024

preview:https://coder.com/docs/@bp-speed-up-templates/tutorials/best-practices/speed-up-templates

description to manifest

00d394b

bpmct approved these changes

Oct 30, 2024

View reviewed changes

Copy link

Member

bpmct left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Awesome!

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

matifali reviewed

Oct 31, 2024

View reviewed changes

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

matifali reviewed

Oct 31, 2024

View reviewed changes

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

johnstcn reviewed

Oct 31, 2024

View reviewed changes

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

EdwardAngertand others added4 commits

October 31, 2024 09:31

Update docs/tutorials/best-practices/speed-up-templates.md

913c6ca

Co-authored-by: Muhammad Atif Ali <atif@coder.com>

suggestions from code review

0725931

typo fix

209671d

move build timeline up in monitoring

5a0ab2a

EdwardAngert commented

Oct 31, 2024

View reviewed changes

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

EdwardAngertand others added2 commits

October 31, 2024 15:20

typo fix

4d3b220

Update docs/tutorials/best-practices/speed-up-templates.md

348fcbb

Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>

bpmct reviewed

Oct 31, 2024

View reviewed changes

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

stirby requested changes

Oct 31, 2024

View reviewed changes

Copy link

Collaborator

stirby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Still reviewing one sec.

docs/manifest.jsonShow resolvedHide resolved

docs/tutorials/best-practices/index.mdShow resolvedHide resolved

docs/tutorials/best-practices/speed-up-templates.md OutdatedShow resolvedHide resolved

docs/tutorials/best-practices/speed-up-templates.md Outdated

		metrics are a part of the Helm chart?]

		Visit the
		[observability repository](https://github.com/coder/observability?tab=readme-ov-file#installation)

Copy link

Collaborator

stirbyOct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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).

Copy link

ContributorAuthor

EdwardAngertOct 31, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'm into this + we should add it to thekubernetes doc

which, aside, something looks busted here.~~Can I tweak the MD?~~ commit incoming

Copy link

Collaborator

stirbyOct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

ContributorAuthor

EdwardAngertOct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

markdown's fixed there
and as aseparate commit(for easy reverting if we need), I added a slightly tweaked version of your suggested text to thek8s install doc (preview).
on ✅ ?