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
Merged
Changes from1 commit
Commits
Show all changes
39 commits
Select commitHold shift + click to select a range
d741460
add definitions to admin/index
EdwardAngertNov 8, 2024
3ed5c3e
init devcontainers best practice doc
EdwardAngertNov 8, 2024
dcf901c
s/definition list/bullets
EdwardAngertNov 8, 2024
16cce07
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngertNov 12, 2024
e96b1bc
admin/index glossary section
EdwardAngertNov 13, 2024
22e399d
when to use a dev container
EdwardAngertNov 13, 2024
4f91cd0
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngertNov 13, 2024
8e37e58
admin/index glossary; devcontainer known issues
EdwardAngertNov 13, 2024
985233a
devcontainer lifecycle scripts
EdwardAngertNov 13, 2024
f2c59be
devcontainers directory
EdwardAngertNov 13, 2024
b24f615
fix typo
EdwardAngertNov 13, 2024
4c28411
make fmt
EdwardAngertNov 13, 2024
fc20dc3
suggestions from review
EdwardAngertNov 20, 2024
197cfa7
add steps in tabs to add-devcontainer
EdwardAngertNov 20, 2024
5a93ff2
fix links; list templates
EdwardAngertNov 20, 2024
8e53735
make fmt + copy review addition
EdwardAngertNov 20, 2024
80bf5da
fix link
EdwardAngertNov 21, 2024
ca56186
typo fix
EdwardAngertNov 21, 2024
1491680
copy edit devcontainer/index
EdwardAngertNov 21, 2024
7f8b079
edit add-devcontainer
EdwardAngertNov 22, 2024
547cfe0
Apply suggestions from code review
EdwardAngertNov 22, 2024
d22f76f
add screenshot
EdwardAngertNov 22, 2024
ce0d2be
make fmt; copy tweaks
EdwardAngertNov 22, 2024
66fcca0
edit example
EdwardAngertNov 22, 2024
de58159
link typo
EdwardAngertNov 22, 2024
69415d4
adjust image size
EdwardAngertNov 22, 2024
ae543de
Apply suggestions from code review
EdwardAngertNov 25, 2024
ca0da6d
Apply suggestions from code review
EdwardAngertNov 25, 2024
381bb73
make fmt
EdwardAngertNov 25, 2024
ade54e9
close codeblock; edit starter template steps
EdwardAngertNov 25, 2024
e46fc13
code review
Nov 26, 2024
9982af4
make fmt
Nov 26, 2024
182d69a
rename to dev containers
Nov 26, 2024
bf2e0fa
2-col table
EdwardAngertNov 26, 2024
cd99937
make fmt
Nov 26, 2024
d17dbea
un-double bullet def list
Nov 26, 2024
2c3ca6d
s/devcontainer/dev container
Nov 26, 2024
c28f16d
comma typo
Nov 26, 2024
f344dff
Merge remote-tracking branch 'origin' into bp-dev-containers
Nov 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
PrevPrevious commit
NextNext commit
admin/index glossary section
  • Loading branch information
@EdwardAngert
EdwardAngert committedNov 13, 2024
commite96b1bc70036c9827a5a40c070e4bf1246a852e9
12 changes: 10 additions & 2 deletionsdocs/admin/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,25 @@ For any information not strictly contained in these sections, check out our
## 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


- **Template**
- [Templates](./templates/index.md) are...
- [Templates](./templates/index.md) are
<!-- Managed by Coder Template Administrators The template should include infrastructure-level dependencies for the workspace (for example, Kubernetes PersistentVolumeClaims, docker containers, or EC2 VMs). These should be applicable to all workspaces built from the template. -->

- **Workspace**
- A [workspace](../user-guides/workspace-management.md) is the environment
that a developer works in. Developers on a team each work from their own
workspace and can use [multiple IDEs](./workspace-access/index.md).
- **Image**
-An [image](./templates/managing-templates/image-management.md) contains the
-A [baseimage](./templates/managing-templates/image-management.md) contains the
utilities that the Coder workspace is built on. It can be an
[example image](https://github.com/coder/images), custom image, or one from
[Docker Hub](https://hub.docker.com/search). It is defined in each template.
Managed externally to Coder.
<!-- The devcontainer base image should include dependencies such as the base OS (for example, Debian or Fedora), and OS-level packages (curl, git, java). Include as much as possible here to leverage image and layer caching. Avoid including project-specific tools here. Language-specific runtimes may be added here or in a Dev Container feature. -->

- **Development containers**
- more about devcontainers...

- **Startup scripts**
-

<children></children>
Loading

[8]ページ先頭

©2009-2025 Movatter.jp