Skip to content

chore: improve prebuilds docs #17850

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 16, 2025
Merged

chore: improve prebuilds docs #17850

merged 7 commits into from
May 16, 2025

Conversation

dannykopping
Copy link
Contributor

These items came up in an internal "bug bash" session yesterday.

@EdwardAngert note: I've reverted to the "transparent" phrasing; the current docs confused a couple folks yesterday, and I feel that "transparent" is clearly understood in this context.

Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
@@ -177,13 +188,13 @@ The prebuilt workspaces feature has these current limitations:

Prebuilt workspaces can only be used with the default organization.

[coder/internal#364](https://github.com/coder/internal/issues/364)
[View issue](https://github.com/coder/internal/issues/364)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it looks nicer in the GitHub link format - it's descriptive and familiar

like this - I'll paste this link below as https://github.com/coder/internal/issues/364 and GitHub does the reformatting thing:

coder/internal#364

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There was some hesitation in the bug bash call around showing coder/internal links because folks might think they're not accessible.

Copy link
Contributor

Choose a reason for hiding this comment

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

oh interesting

works for me either way

dannykopping and others added 2 commits May 16, 2025 07:57
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
also, there is no "maintenance" of prebuilt workspaces, so dropped that

Signed-off-by: Danny Kopping <dannykopping@gmail.com>
@dannykopping dannykopping requested a review from EdwardAngert May 16, 2025 06:00
@dannykopping dannykopping merged commit 8914f7a into main May 16, 2025
33 checks passed
@dannykopping dannykopping deleted the dk/prebuilds-docs-limitation branch May 16, 2025 17:25
@github-actions github-actions bot locked and limited conversation to collaborators May 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants