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 workspaces and templates doc#9139

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
matifali merged 42 commits intocoder:templates-docsfrommarcpaq:templates-docs
Oct 16, 2023

Conversation

marcpaq
Copy link
Contributor

@marcpaqmarcpaq commentedAug 16, 2023•
edited
Loading

Hi@bpmct ,@kylecarbs

Here's a first draft for the workspaces doc page.

  • reorg: start with conceptual, then getting started asap, then details about managing workspaces
  • more consistent withCoder's contributor guidelines
  • used more 2nd person
  • replaced passive voice with active when it made more sense
  • more consistent terminology
  • a new screenshot, updated a few other screenshots

I have read the CLA Document and I hereby sign the CLA

@cdr-botcdr-botbot added the communityPull Requests and issues created by the community. labelAug 16, 2023
@github-actions
Copy link

github-actionsbot commentedAug 16, 2023•
edited
Loading

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@matifali
Copy link
Member

Hi@marcpaq can you please mergemain as I have updated the formatter to enforce an 80 character line length

marcpaq reacted with thumbs up emoji

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.

Just a comment about the correct use ofshell andconsole for markdown fenced codeblocks

marcpaq reacted with thumbs up emoji
marcpaqand others added3 commitsAugust 25, 2023 03:07
Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Muhammad Atif Ali <matifali@live.com>
@marcpaq
Copy link
ContributorAuthor

I have read the CLA Document and I hereby sign the CLA

cdrcommunity added a commit to coder/cla that referenced this pull requestAug 25, 2023
I have read the CLA Document and I hereby sign the CLA
@marcpaqmarcpaq changed the titleReorg, updated/new screenshots, consistent terminologyReorg, updated and new screenshots, consistent terminologyAug 28, 2023
@bpmctbpmct changed the titleReorg, updated and new screenshots, consistent terminologydocs: workspaces and templates documentationSep 3, 2023
@bpmct
Copy link
Member

For the "Advanced: Building your first template" doc:

  • Ephemerality (a disk is kept, but the container is deleted when a workspace is stopped)
  • One or two agent metadata items (CPU, RAM)
  • You can name resources after the workspace name
  • You shouldbulletproof important resources, like disks, so future template updates don't delete them.
marcpaq reacted with thumbs up emoji

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.

I have left a few comments, suggestions, and some questions. Overall it looks very good.

matifali
matifali previously requested changesOct 4, 2023
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.

Delete the section related to legacy parameters and the migration guide.

@matifali
Copy link
Member

Hi@marcpaq, I have deleted the section on legacy parameters. Is there anything blocking you on this? Can you review it once and see if any observations must be addressed?
We should merge this sooner to think about other refactors.

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.

Ok I pushed a commit to fix the broken links in the product.

However, did these docs disappear? I think we might need to add a templates/troubleshooting.md back. I am happy to author this and do it first thing tomorrow.

return(
<TerminalAlert
severity="warning"
dismissible
actions={<RefreshSessionButton/>}
>
The workspace{" "}
<Link
title="startup script has exited with an error"
href={docs("/templates#startup-script-exited-with-an-error")}
target="_blank"
rel="noreferrer"
>
startup script has exited with an error
</Link>
, we recommend reloading this session and{" "}
<Link
title=" debugging the startup script"
href={docs("/templates#debugging-the-startup-script")}
target="_blank"
rel="noreferrer"
>
debugging the startup script
</Link>{" "}
because{" "}
<Link
title="your workspace may be incomplete."
href={docs("/templates#your-workspace-may-be-incomplete")}
target="_blank"
rel="noreferrer"
>
your workspace may be incomplete.
</Link>{" "}
</TerminalAlert>
);
};
exportconstLoadingScriptsAlert=()=>{
return(
<TerminalAlert
dismissible
severity="info"
actions={<RefreshSessionButton/>}
>
Startup scripts are still running. You can continue using this terminal,
but{" "}
<Link
title="your workspace may be incomplete."
href={docs("/templates#your-workspace-may-be-incomplete")}
target="_blank"
rel="noreferrer"
>
{" "}
your workspace may be incomplete.
</Link>
</TerminalAlert>
);
};
exportconstLoadedScriptsAlert=()=>{
return(
<TerminalAlert
severity="success"
dismissible
actions={<RefreshSessionButton/>}
>
Startup scripts have completed successfully. The workspace is ready but
this{" "}
<Link
title="session was started before the startup scripts finished"
href={docs("/templates#your-workspace-may-be-incomplete")}
target="_blank"
rel="noreferrer"
>
session was started before the startup script finished.
</Link>{" "}
To ensure your shell environment is up-to-date, we recommend reloading
this session.
</TerminalAlert>
);
};

Otherwise, I think we're good to merge

matifali reacted with thumbs up emoji

As well as Coder's starter templates, you can see a list of community
templates by our users
[here](https://github.com/coder/coder/blob/main/examples/templates/community-templates.md).
Copy link
Member

Choose a reason for hiding this comment

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

Should we also mention registry.coder.com/templates?

Copy link
Member

Choose a reason for hiding this comment

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

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.

fixed the links - we're all good to merge :)

matifali reacted with hooray emojimatifali reacted with heart emoji
@matifalimatifali merged commit3279747 intocoder:templates-docsOct 16, 2023
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsOct 16, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali approved these changes

@mtojekmtojekmtojek left review comments

@bpmctbpmctbpmct approved these changes

Assignees

@marcpaqmarcpaq

Labels
communityPull Requests and issues created by the community.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

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