Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: improve dev containers documentation for user start-up#15458

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

Merged
EdwardAngert merged 39 commits intomainfrombp-dev-containers
Dec 2, 2024

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngertEdwardAngert commentedNov 8, 2024•
edited
Loading

preview

@EdwardAngertEdwardAngert added the docsArea: coder.com/docs labelNov 8, 2024
@EdwardAngertEdwardAngert self-assigned thisNov 8, 2024
@EdwardAngertEdwardAngert changed the titledocs: add new best practice doc to help users get started with dev containersdocs: edit devcontainers doc to help users get started with dev containersNov 8, 2024
@EdwardAngertEdwardAngert marked this pull request as draftNovember 8, 2024 19:52
@EdwardAngertEdwardAngert changed the titledocs: edit devcontainers doc to help users get started with dev containersdocs: edit devcontainers doc to help users get started with dev containers [WIP]Nov 8, 2024
@EdwardAngertEdwardAngert changed the titledocs: edit devcontainers doc to help users get started with dev containers [WIP]docs: update devcontainers doc to help users get started with dev containers [WIP]Nov 12, 2024
@EdwardAngertEdwardAngert changed the titledocs: update devcontainers doc to help users get started with dev containers [WIP]docs: get users started with dev containers by updating the devcontainers doc [WIP]Nov 12, 2024
@EdwardAngertEdwardAngert changed the titledocs: get users started with dev containers by updating the devcontainers doc [WIP]docs: update the dev containers doc to help users get started with dev containersNov 20, 2024
Copy link
Member

@bpmctbpmct left a comment

Choose a reason for hiding this comment

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

Hey, good start. Left a ton of comments, but please don't get discouraged. I'd also spend some time comparing it to other formatting and styles in our docs.

Of course, our docs style should incrementally change and improve over time, but I think by comparing this to other sections, we'll find good opportunities to improve this PR as well.

@@ -15,4 +15,56 @@ and [API](../reference/api/index.md) docs.
For any information not strictly contained in these sections, check out our
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).

## What is an image, template, devcontainer, or workspace
Copy link
Member

Choose a reason for hiding this comment

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

This may be best presented as a table as this renders quite awkward.

Also I am not sure if this is best on the frontpage of administration. We have no other content here at all. If we do think this is the most important admin concept, we might want to add a sentence explaining why its so important and what else people can expect on the Administration page

Screenshot 2024-11-24 at 9 10 03 PM

Copy link
Member

Choose a reason for hiding this comment

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

This can also be folded into the upcoming Glossay@EdwardAngert is working on.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I can try a table on and see how it feels - I'd tried an html definition list and it looked okay, but everything within the html would also have to be html (like links), and that didn't seem worth it. my concern with tables is how long text shows in cells, but it's worth a shot

the hope is to have this be a glossary component at some point so that we can define terms in place and have them combined into reference pages

here's anexample in the MyST docs

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

it's also interesting that you're still getting served a build of an older commit :-/ not sure why that is

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

adjusted to:

2024-11-26_14-45-53

Comment on lines +13 to +16
## Layer and image caching

To improve build times, dev containers can be cached. There are two main forms
of caching:
Copy link
Member

Choose a reason for hiding this comment

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

nice-to-have: a diagram could be really neat here!

@@ -15,4 +15,56 @@ and [API](../reference/api/index.md) docs.
For any information not strictly contained in these sections, check out our
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).

## What is an image, template, devcontainer, or workspace
Copy link
Member

Choose a reason for hiding this comment

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

This can also be folded into the upcoming Glossay@EdwardAngert is working on.

Comment on lines +127 to +128
Your template can prompt the user for a repo URL with
[parameters](../../extending-templates/parameters.md):
Copy link
Member

Choose a reason for hiding this comment

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

May also mention to use thegit-clone module from the registry.

Copy link
Member

Choose a reason for hiding this comment

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

We have a general image sizing issue through out docs. Related#15495

Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

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

Left a few comments to improve. But overall looks great.

Co-authored-by: Ben Potter <ben@coder.com>
@@ -15,4 +15,56 @@ and [API](../reference/api/index.md) docs.
For any information not strictly contained in these sections, check out our
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).

## What is an image, template, devcontainer, or workspace
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I can try a table on and see how it feels - I'd tried an html definition list and it looked okay, but everything within the html would also have to be html (like links), and that didn't seem worth it. my concern with tables is how long text shows in cells, but it's worth a shot

the hope is to have this be a glossary component at some point so that we can define terms in place and have them combined into reference pages

here's anexample in the MyST docs

@@ -15,4 +15,56 @@ and [API](../reference/api/index.md) docs.
For any information not strictly contained in these sections, check out our
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).

## What is an image, template, devcontainer, or workspace
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

it's also interesting that you're still getting served a build of an older commit :-/ not sure why that is

@EdwardAngertEdwardAngert changed the titledocs: update the dev containers doc to help users get started with dev containersdocs: improve dev containers documentation for user start-upNov 26, 2024
Edward Angertand others added5 commitsNovember 26, 2024 19:18
@EdwardAngert
Copy link
ContributorAuthor

@matifali looks like the CI is failing due to the broken link introduced in#15610 . I sawyour comment about it in that PR - should we hold off on this PR until it's fixed?

@matifali
Copy link
Member

@EdwardAngert docs checks is not a required check and we can merge without it.

Update: the said PR is now merged and the link should work.

EdwardAngert reacted with hooray emoji

@EdwardAngert
Copy link
ContributorAuthor

EdwardAngert commentedNov 27, 2024•
edited
Loading

(auto-)merging as a first iteration

@EdwardAngertEdwardAngertenabled auto-merge (squash)November 27, 2024 18:41
@EdwardAngertEdwardAngert merged commitb06d833 intomainDec 2, 2024
24 of 25 checks passed
@EdwardAngertEdwardAngert deleted the bp-dev-containers branchDecember 2, 2024 17:19
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@matifalimatifalimatifali approved these changes

@bpmctbpmctbpmct approved these changes

@mdantermdanterAwaiting requested review from mdanter

@mattvollmermattvollmerAwaiting requested review from mattvollmer

@johnstcnjohnstcnAwaiting requested review from johnstcn

Assignees

@EdwardAngertEdwardAngert

Labels
docsArea: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@EdwardAngert@matifali@johnstcn@bpmct
[8]ページ先頭
©2009-2025 Movatter.jp