Skip to content

docs: adding a tutorial for persistent shared workspaces#23738

Open
zenithwolf1000 wants to merge 2 commits intomainfrom
sp/sw-docs-ga
Open

docs: adding a tutorial for persistent shared workspaces#23738
zenithwolf1000 wants to merge 2 commits intomainfrom
sp/sw-docs-ga

Conversation

@zenithwolf1000
Copy link
Copy Markdown
Contributor

No description provided.

@github-actions github-actions bot added the community Pull Requests and issues created by the community. label Mar 27, 2026
@coder-tasks
Copy link
Copy Markdown
Contributor

coder-tasks bot commented Mar 27, 2026

Documentation Check

Issues Found in New Tutorial

The new tutorial at docs/tutorials/persistent-shared-workspaces.md has several correctness issues that should be addressed before merging:

Critical: Not added to docs/manifest.json

All documentation pages must be added to docs/manifest.json to appear in navigation. The new tutorial is missing from the manifest.

[x] ✅ Fixed in commit d3cfcb2 — the tutorial is now included in docs/manifest.json.

⚠️ Note: The indentation of the newly added manifest entries is inconsistent with surrounding entries (extra level of indentation). This is cosmetic but may trip the markdown linter.

Invalid CLI command: mutually exclusive flags

In Step 1, the coder users create command uses --login-type none, --email, and --service-account together:

coder users create \
  --username oncall-sre \
  --email oncall-sre@yourcompany.com \
  --login-type none \
  --service-account

These flags are mutually exclusive. The CLI explicitly returns: "You cannot use --login-type with --service-account" and "You cannot use --email with --service-account". Remove both --login-type none and --email — the --service-account flag already implies login-type=none. The corrected command is:

coder users create \
  --username oncall-sre \
  --service-account
  • Fix the coder users create command in Step 1.

Non-standard header block

The <div> author attribution block and inline date at the top of the file are not present in any other Coder tutorial. Remove these to match the standard tutorial format.

  • Remove the <div> block and the March, 2026 date line.

Minor Suggestions

  • Step 4: The first example shares without a role (--user alice). The CLI defaults to the use role when no role is specified (this is valid), but a note clarifying the default would help readers. Alternatively, use --user alice:use for explicit clarity.
  • Finding shared workspaces: coder list --search shared:true uses an undocumented filter syntax — a note linking to the search query reference would help readers.

Automated review via Coder Tasks
<!-- doc-check-sticky -->

@zenithwolf1000 zenithwolf1000 changed the title adding a tutorial for persistent shared workspaces docs: adding a tutorial for persistent shared workspaces Mar 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant