Skip to content

docs: describe support channels and what to include in a support request - #31992

Open
nickvigilante wants to merge 5 commits into
mainfrom
docs/support-request-guidance
Open

nickvigilante wants to merge 5 commits into
mainfrom
docs/support-request-guidance

Conversation

@nickvigilante

Copy link
Copy Markdown
Collaborator

Expands the Support landing page, which currently only points to GitHub issues and Discord:

  • Splits Community support (GitHub, Discord) from Premium support (the Coder support portal and the account team).
  • Adds What to include in a support request: version (GET /api/v2/buildinfo), support bundle and logs, reproduction steps, impact, and deadlines. Deadlines matter most here: knowing a customer's event or rollout date early changes how we prioritize.
  • Notes that a proposed fix is welcome but doesn't replace reproduction details.

The manifest description already mentions premium support, so no manifest change is needed.

Needs Support / CS confirmation before merge

  • OK to publish help.coder.com as the Premium support entry point
  • Wording for contacting the account team, and whether to mention shared Slack channels
  • Wording of the proposed-fix paragraph

Linear: DOCS-1731

Supersedes #31945, reopened under a human author for attribution.

@nickvigilante nickvigilante added the community Pull Requests and issues created by the community. label Nov 10, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante nickvigilante self-assigned this Nov 10, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive

@coderagents coderagents Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated documentation review (doc-check). See findings below and the summary comment.

Comment thread docs/support/index.md Resolved
Comment thread docs/support/index.md Resolved
Comment thread docs/support/index.md Resolved
Comment thread docs/support/index.md Resolved
Comment thread docs/support/index.md Resolved
@coderagents

coderagents Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Documentation Check

Blocking

  • docs/support/index.md (open) - Line 5: "open source edition of Coder" and "Coder Premium license" are new terms for concepts the rest of the docs already name ("open source software (OSS)", "a Premium license"). See inline comment.
  • docs/support/index.md (open) - Line 21: The Coder version bullet leads with a raw API call instead of the dashboard surface where the version is already visible, and gives no way to check the CLI client version it also asks for.
  • docs/support/index.md (open) - Line 28: Comma splice before "and" (shared subject), plus "above" is banned directional language for screen-reader users.
  • docs/support/index.md (open) - Line 14: "contact your Coder account team" should link to https://coder.com/contact, like every other instance of this phrase in the docs.
  • docs/support/index.md (open) - Line 24: "see the ... article" uses the banned navigational verb "see" for an external URL. Fixed by using "visit".
  • docs/support/index.md (open) - Line 24: The sentence reads "visit the Scope of Support KB article article", duplicating the word "article" (and using "KB" as "knowledge base", which the abbreviation exemption only covers for the kilobyte sense). See inline comment.

Design notes

  • docs/reference/feature-stages.md's General Availability section already describes a different, less detailed support path for licensed customers ("submit a support request or contact your account team," coder.com/contact) with no mention of the Premium support portal this PR adds. The two pages will keep drifting until reconciled.
  • The "What to include in a support request" list now lives under Community support only; Premium readers are routed to the external Scope of Support KB article. The KB article is the support team's stated source of truth and could not be read from this environment, so its coverage (severity levels, request contents) is unverified here.
  • The Impact and Deadlines bullets and the proposed-fix note were removed from the page. The author's stated plan is for the KB article to cover them; that content was not verifiable from this environment.
Findings for agents
- id: broken-1
  persona: language
  class: broken
  blocking: true
  file: docs/support/index.md
  line: 24
  quote: "For what Coder support covers, how to submit a request, and severity levels, visit the [Scope of Support KB article](https://kb.coder.com/articles/8704847707-scope-of-support) article."
  evidence:
    - docs/support/index.md:24
  rule: null
  problem: The rendered sentence duplicates the word "article" ("visit the Scope of Support KB article article") because the link label already ends with "article" and the prose repeats it after the link. "KB" is also used for "knowledge base", a sense the Coder.AbbreviationFirstUse exemption does not cover.
  fix: "For what Coder support covers, how to submit a request, and severity levels, visit the [Scope of Support article](https://kb.coder.com/articles/8704847707-scope-of-support)."
  verified: true

- id: coverage-1
  persona: coverage
  class: adjacent
  blocking: false
  file: docs/support/index.md
  line: 11
  quote: "When you report an issue, include the following:"
  evidence:
    - docs/support/index.md (removed the Impact and Deadlines bullets; the request-content list is now scoped to Community only)
  rule: null
  problem: Impact and Deadlines guidance and the proposed-fix note were removed from the docs; the request-content list now applies only to Community support. The author's stated plan is for the KB article to cover them. The KB was not verifiable from this environment.
  fix: Restore the Impact and Deadlines bullets under the request-content list, or confirm the KB article covers them.
  verified: true

Automated review via Coder Agents. Reply to a finding's thread with the reason if the finding is wrong.

@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 22:10 — with GitHub Actions Inactive
coder Bot and others added 2 commits November 12, 2026 14:12
Use the glossary's Community and Premium tier names, link the account
team to coder.com/contact like other pages, lead the version bullet with
the dashboard and `coder version` before the API, and fix the comma and
directional wording in the proposed-fix paragraph.
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


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


2 out of 3 committers have signed the CLA.
✅ (nickvigilante)[https://github.com/nickvigilante]
✅ (rowansmithau)[https://github.com/rowansmithau]
❌ @coder[bot]
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview

Links open this pull request's preview at https://pr-31992.docs.cdr-preview.dev, which updates with each push.

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

Preview sites for each built commit (3)

Every built commit keeps its own preview, newest first. Previews aren't indexed by search engines and are deleted when this pull request is merged or closed.

Comment thread docs/support/index.md Outdated

If you have a question, encounter an issue or bug, or have a feature request, [open a GitHub issue](https://github.com/coder/coder/issues/new) or [join our Discord](https://discord.gg/coder).

## Premium support

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hey @nickvigilante, thanks for working on this. I would suggest a different approach though - we have https://kb.coder.com/articles/8704847707-scope-of-support which we in the support team maintain and consider to be the source of truth. I would prefer the coder.com/docs page link to that when referencing the "customers with a premium license" scenario instead of duplicating that info into the docs.

There is some text in your proposed approach that I do think we could include in the scope of support article, so I'll look to update that as a side task.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Agreed on linking to this page. I wasn't aware this existed, so I'll happily just point users to that page instead. I won't squash commits so that you can go back in the history and pull in whatever changes you need. Thanks!

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in 31e9853. The Premium support section now links to the Scope of Support article, and I removed the "What to include in a support request" section from the Premium path. I compared it against the article first. The article already covers version, support bundle and logs, so those are no longer duplicated for Premium customers. Reproduction steps, impact, deadlines and the proposed-fix note are not in the article, so I dropped them from the docs for you to add there. I kept version, support bundle and reproduction steps under Community support, since GitHub reporters have no equivalent.

Reply generated by Coder Agents on behalf of @nickvigilante.

Comment thread docs/support/index.md Outdated

## Premium support

If your organization has a [Premium license](../install/prepare/licensing.md), open and track support tickets in the [Coder support portal](https://help.coder.com).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The licensing.md link now in place covers adding a license, but doesn't tell the reader how to check which tier (Community or Premium) their deployment currently has (Newcomer). docs/install/prepare/licensing.md has no section for this; the closest content is a screenshot of the Admin settings > Deployment > Licenses screen (line 9), never tied in prose to "check what you have." A reader who doesn't already know their tier still can't resolve it from either page.

Add a short FAQ entry to docs/install/prepare/licensing.md (matching its existing "Find your deployment ID" FAQ pattern) that tells the reader where to see their current license, for example a ### Check your current license entry pointing to Admin settings > Deployment > Licenses. This is not a local edit to this line, so no suggestion block is included.

Comment thread docs/support/index.md Outdated
## Premium support

If your organization has a [Premium license](../install/prepare/licensing.md), open and track support tickets in the [Coder support portal](https://help.coder.com).
You can also [contact your Coder account team](https://coder.com/contact).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

(Continuity Editor) 9 of the 11 other pages that link this phrase write it as "contact your account team" (no "Coder"): docs/admin/security/audit-logs.md:10, docs/admin/monitoring/connection-logs.md:7, docs/admin/networking/workspace-proxies.md:9, docs/admin/external-auth.md:363, docs/admin/users/groups-roles.md:12, docs/admin/users/organizations.md:7,43, docs/workspaces/persistent-shared-workspaces.md:7, docs/reference/feature-stages.md:192. Only feature-stages.md:170 and ai-governance/index.md:64 also say "Coder account team".

Suggested change
You can also [contact your Coder account team](https://coder.com/contact).
You can also [contact your account team](https://coder.com/contact).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fixed in 72dfc77.

@nickvigilante
nickvigilante temporarily deployed to docs-preview November 13, 2026 19:35 — with GitHub Actions Inactive
Comment thread docs/support/index.md Resolved
@nickvigilante
nickvigilante temporarily deployed to docs-preview November 13, 2026 19:56 — with GitHub Actions Inactive
Comment thread docs/support/index.md Resolved
Co-authored-by: coderagents[bot] <254784001+coderagents[bot]@users.noreply.github.com>
@nickvigilante
nickvigilante enabled auto-merge (squash) November 16, 2026 18:22

This branch had an error being deployed

1 failed and 1 inactive (outdated) deployments
main — 7e94be45 Deployed Nov 15, 2026 by rowansmithau via cla #257138
docs-preview — 72dfc772 Deployed Nov 13, 2026 by nickvigilante via deploy #179
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.

2 participants