-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: add Template Insights documentation #21150
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Adds comprehensive documentation for the Template Insights feature, which was previously undocumented. The documentation covers: - What Template Insights are and their purpose - How to access and use Template Insights - Available metrics (active users, app usage, user activity, latency, parameters) - Use cases for capacity planning, optimization, and support - Permissions and RBAC considerations - Troubleshooting guidance Also updates: - CLAUDE.md with workflow for reading GitHub issues before starting work - dogfood/coder/main.tf with GitHub CLI authentication in startup script - docs/admin/templates/index.md to link to the new documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds a screenshot showing the Template Insights page with the Weekly Active Users chart and Latency by user section to help users visualize the feature. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds complete documentation for the Template Insights feature covering: - Overview of active users, app usage, user activity, latency, and parameters - Step-by-step access instructions with permission requirements - Visual examples with three screenshots showing key metrics - Use cases for template optimization, capacity planning, and user support - Permission model and data privacy considerations - API access documentation Includes three new screenshots illustrating the insights interface and metrics. Closes #21138 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This section was added in a previous commit but is unrelated to the Template Insights documentation work.
Proactively documents the --disable-template-insights flag from PR #20940 before it merges, ensuring documentation is ready when the feature lands.
Removed as it's being handled in another PR.
|
|
||
| When disabled, insights data will not be collected or stored, and the Insights tab will not be available in the UI. | ||
|
|
||
| See the [CLI reference](../../reference/cli/server.md#--disable-template-insights) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../../reference/cli/server.md#--disable-template-insights Status: 404 Cannot find section: #--disable-template-insights in file: /home/runner/work/coder/coder/docs/reference/cli/server.md.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need #20940 to be merged, then we'll rebase
When working on PRs, Claude Code was sometimes force pushing to branches. This adds simple git workflow guidelines emphasizing: - Check out PR branches properly (fetch, checkout, pull) - Don't use git push --force unless explicitly requested Examples of PRs with multiple commits from iterative work: - #21148: 7 commits including merge commit - #21150: 9 commits with iterative documentation changes - #21182: 4 commits with fixes - Also observed force updates on feat/add-tasks-template-flag branch 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
When working on PRs, Claude Code was sometimes force pushing to branches. This adds simple git workflow guidelines that emphasize proper branch checkout and avoiding force pushes. ## Changes Added git workflow section to `CLAUDE.md`, `AGENTS.md`, and `.claude/docs/WORKFLOWS.md` with: - Instructions to fetch, checkout, and pull before working on PR branches - Note to avoid `git push --force` unless explicitly requested ## Examples of force push behavior Observed in recent PRs: - PR #21148: 7 commits including merge commit from iterative changes - PR #21150: 9 commits with multiple documentation iterations - PR #21182: 4 commits with iterative fixes - Force update on `feat/add-tasks-template-flag` branch: `9bf7980b9...f98cf44` The guidelines now make it clear to check out branches properly and push normally. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds end-user documentation for the Template Insights feature at
docs/admin/templates/template-insights.md, covering usage, metrics, permissions, and configuration.The documentation explains how to access Template Insights, describes all available metrics (Active Users with automatic daily/weekly intervals, User Latency with color-coded thresholds at 150ms and 300ms, App & IDE Usage, Activity by User, Template Parameters distribution), details the RBAC permission model with the
view_insightsaction, provides use cases for template optimization and capacity planning, and references the API endpoints. Proactively documents the--disable-template-insightsserver flag from PR #20940 before it merges.Includes three screenshots showing the Weekly Active Users chart, latency table, application usage rankings, and parameter distributions. Added to
docs/manifest.jsonfor navigation.Closes #21138
🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com