docs: catch up documentation with recent feature changes#72
docs: catch up documentation with recent feature changes#72TerrifiedBug merged 2 commits intomainfrom
Conversation
Update 9 docs/public files with 18 undocumented user-facing changes: - pipeline-editor: discard changes button, log search with highlighting - dashboard: analytics page (Events Reduced/Bytes Saved KPIs, per-pipeline table with progress bars), custom view drag/resize - pipelines: four-eyes deploy approval (self-approval blocked, admin bypass) - fleet: compact label display with popover - authentication: teamless SSO block page, multi-select team mapping, SSO hint in Add Member, SSO-only login layout - backup-restore: download button for super-admins, failed backup alert - configuration: VF_LOG_LEVEL server env var - scim: externalId in Group responses - agent: dev update channel, --channel flag
Greptile SummaryThis is a pure documentation PR that backfills 18 undocumented user-facing changes across 9 Issues found:
7 of 9 files are clean documentation additions with no issues. Confidence Score: 3/5
|
docs/public/reference/agent.md
Outdated
| |------|-------------| | ||
| | `--version`, `-v` | Print the agent version and exit | | ||
| | `--help`, `-h` | Show usage help including the environment variable reference | | ||
| | `--channel <name>` | Set the update channel: `stable` (default) or `dev`. Dev channel agents receive pre-release binaries and are tracked separately in the fleet UI. | |
There was a problem hiding this comment.
The CLI flags table description for --channel doesn't mention that it is enrollment-time only. The Update channels section (line 287) clearly states "Set via --channel dev at first startup" and "cannot be changed without re-installing", but a user reading only the flags table would believe they can switch channels on a running agent by restarting with --channel dev.
| | `--channel <name>` | Set the update channel: `stable` (default) or `dev`. Dev channel agents receive pre-release binaries and are tracked separately in the fleet UI. | | |
| | `--channel <name>` | Set the update channel at enrollment time: `stable` (default) or `dev`. Only effective on first startup — after enrollment the channel is fixed by the agent's version string prefix and cannot be changed without re-installing. | |
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/public/reference/agent.md
Line: 95
Comment:
The CLI flags table description for `--channel` doesn't mention that it is **enrollment-time only**. The Update channels section (line 287) clearly states "Set via `--channel dev` at first startup" and "cannot be changed without re-installing", but a user reading only the flags table would believe they can switch channels on a running agent by restarting with `--channel dev`.
```suggestion
| `--channel <name>` | Set the update channel at enrollment time: `stable` (default) or `dev`. Only effective on first startup — after enrollment the channel is fixed by the agent's version string prefix and cannot be changed without re-installing. |
```
How can I resolve this? If you propose a fix, please make it concise.…agent channel flag - pipelines.md: change "admin approval" to "deploy approval" since both editors and admins can approve deploy requests - agent.md: clarify --channel flag is enrollment-time only in the flags table
Summary
docs/public/files with 18 undocumented user-facing changes from PRs feat: dev binary channel with CLI flags and auto-update #11–fix: return externalId in SCIM Groups responses #69Test plan