Repository navigation
docs: describe support channels and what to include in a support request - #31992
nickvigilante wants to merge 5 commits into
Conversation
Documentation CheckBlocking
Design notes
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: trueAutomated review via Coder Agents. Reply to a finding's thread with the reason if the finding is wrong. |
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.
db049d9 to
52c9af1
Compare
|
I have read the CLA Document and I hereby sign the CLA 2 out of 3 committers have signed the CLA. |
Docs previewLinks 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. |
|
|
||
| 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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.
|
|
||
| ## 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). |
There was a problem hiding this comment.
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.
| ## 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). |
There was a problem hiding this comment.
(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".
| You can also [contact your Coder account team](https://coder.com/contact). | |
| You can also [contact your account team](https://coder.com/contact). |
Co-authored-by: coderagents[bot] <254784001+coderagents[bot]@users.noreply.github.com>
Expands the Support landing page, which currently only points to GitHub issues and Discord:
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.The manifest description already mentions premium support, so no manifest change is needed.
Needs Support / CS confirmation before merge
Linear: DOCS-1731
Supersedes #31945, reopened under a human author for attribution.