Skip to content

docs: catch up documentation with recent feature changes#72

Merged
TerrifiedBug merged 2 commits intomainfrom
docs/catch-up-2026-03-08
Mar 8, 2026
Merged

docs: catch up documentation with recent feature changes#72
TerrifiedBug merged 2 commits intomainfrom
docs/catch-up-2026-03-08

Conversation

@TerrifiedBug
Copy link
Copy Markdown
Owner

Summary

  • Updates 9 docs/public/ files with 18 undocumented user-facing changes from PRs feat: dev binary channel with CLI flags and auto-update #11fix: return externalId in SCIM Groups responses #69
  • Covers pipeline editor (discard changes, log search), dashboard (analytics page, custom view drag/resize), pipelines (four-eyes deploy approval), fleet (compact labels), authentication (teamless SSO block, multi-select mapping, SSO hint, SSO-only layout), backup-restore (download, failed alert), configuration (VF_LOG_LEVEL), SCIM (externalId), and agent (dev channel)
  • Pure documentation — no code changes

Test plan

  • Verify GitBook renders all 9 files without syntax errors (hints, tabs, steppers)
  • Spot-check each new section matches actual UI behavior
  • Confirm no broken internal links between docs pages

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
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 8, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 8, 2026

Greptile Summary

This is a pure documentation PR that backfills 18 undocumented user-facing changes across 9 docs/public/ files, covering the pipeline editor (discard changes, log search), dashboard (analytics page, custom view drag/resize), pipelines (four-eyes deploy approval), fleet (compact labels), authentication (teamless SSO block, multi-select mapping, SSO hint, SSO-only layout), backup-restore (download, failed alert), configuration (VF_LOG_LEVEL), SCIM (externalId), and the agent (dev update channel). No code is changed.

Issues found:

  • docs/public/user-guide/pipelines.md — The introductory sentence says "admin approval" but the feature description clarifies that both editors and admins can approve deploy requests. This inconsistency should be corrected to avoid misleading users.
  • docs/public/reference/agent.md — The CLI flags table describes --channel <name> without indicating it is enrollment-time only. The separate Update channels section clarifies the flag is only effective at first startup and cannot be changed afterward, but users reading only the flags table would be misled.

7 of 9 files are clean documentation additions with no issues.

Confidence Score: 3/5

  • Safe to merge after fixing two documentation consistency issues — no code changes are included, and both issues are straightforward one-line edits.
  • 7 of 9 files are clean documentation additions with no issues. Two files contain verified documentation inconsistencies that could mislead users: pipelines.md intro says "admin approval" when editors can also approve, and agent.md CLI flags table omits the enrollment-time-only constraint for --channel. Both are real clarity issues that warrant fixing before merge, but are simple to correct. The remaining 7 files are accurate and complete.
  • docs/public/user-guide/pipelines.md (intro wording on line 185) and docs/public/reference/agent.md (CLI flags table description on line 95).

Comments Outside Diff (1)

  1. docs/public/user-guide/pipelines.md, line 185 (link)

    The introductory sentence says "admin approval" but step 4 (line 192) and the info hint (line 200) clarify that both editors and admins can approve deploy requests. The intro should reflect this — currently it could mislead readers into thinking only admins can approve.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: docs/public/user-guide/pipelines.md
    Line: 185
    
    Comment:
    The introductory sentence says "admin approval" but step 4 (line 192) and the info hint (line 200) clarify that **both editors and admins** can approve deploy requests. The intro should reflect this — currently it could mislead readers into thinking only admins can approve.
    
    
    
    How can I resolve this? If you propose a fix, please make it concise.

Last reviewed commit: a071b89

|------|-------------|
| `--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. |
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 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.

Suggested change
| `--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
@TerrifiedBug TerrifiedBug merged commit deb670b into main Mar 8, 2026
2 checks passed
@TerrifiedBug TerrifiedBug deleted the docs/catch-up-2026-03-08 branch March 8, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant