mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-10 18:56:53 +00:00
docs: reorganize navigation for feature discoverability (#1147)
Restructures the Documentation tab so each group answers one operator question. - Split the 12-page "Stacks & Deployments" into Stacks (per-stack work) and Deployment (the act of deploying); promote Resources Hub to a standalone item. - Dissolve the 2-page "Platform" junk drawer: Sidebar moves to Stacks, Host Console moves to Fleet. - Rename "Fleet & Multi-Node" to "Fleet"; absorb Node Compatibility from Reference. Move Scheduled Operations from Fleet to Automation (now a 4-page group covering Scheduled Ops, Auto-Update, Auto-Heal, Webhooks). - Clean up the Reference tab: drop misplaced node-compatibility, move root-level security.mdx into reference/, delete the orphan reference/verifying-images.mdx after porting its Available Tags table into operations/verifying-images.mdx. - Reorder top-level groups: Operations moves above Reference. - Rename two misleading page titles: "Deploy Progress Modal" becomes "Deploy Progress" (drops the UI implementation leak); "Auto-Update Readiness" becomes "Auto-Update Policies" (matches filename and sibling "Auto-Heal Policies"). Verified: docs.json parses as valid JSON, 59 disk .mdx files match 59 nav entries with zero orphans and zero broken refs.
This commit is contained in:
Anso
@@ -117,7 +117,7 @@ Clicking **Deploy** runs the following sequence:
|
||||
|
||||
## Watching the deploy
|
||||
|
||||
Sencho can stream the live `docker compose` output for every template install. Open **Settings › Appearance › Display** and enable **Deploy progress modal**; from then on, every App Store deploy opens a structured log modal you can minimise to a pill that follows you across navigation. See [Deploy Progress Modal](/features/deploy-progress) for the full reference.
|
||||
Sencho can stream the live `docker compose` output for every template install. Open **Settings › Appearance › Display** and enable **Deploy progress modal**; from then on, every App Store deploy opens a structured log modal you can minimise to a pill that follows you across navigation. See [Deploy Progress](/features/deploy-progress) for the full reference.
|
||||
|
||||
<Note>
|
||||
Deploying a template requires the `stack:create` permission on the target node, which **admin** and **node-admin** roles hold by default. The Deploy button stays disabled when your account does not have it.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
title: "Auto-Update Readiness"
|
||||
title: "Auto-Update Policies"
|
||||
description: "Review pending container updates across your fleet, with risk badges, changelogs, and scheduled run times, before applying."
|
||||
---
|
||||
|
||||
<Note>
|
||||
Auto-Update Readiness requires a **Skipper** or **Admiral** license.
|
||||
Auto-Update Policies require a **Skipper** or **Admiral** license.
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
@@ -13,7 +13,7 @@ description: "Review pending container updates across your fleet, with risk badg
|
||||
|
||||
## Overview
|
||||
|
||||
Auto-Update Readiness is the launchpad for every pending update across your stacks. Instead of a list of CRUD policies, the view surfaces one card per stack with an available update and tells you, at a glance, whether it is safe to apply.
|
||||
Auto-Update Policies are the launchpad for every pending update across your stacks. Instead of a list of CRUD policies, the view surfaces one card per stack with an available update and tells you, at a glance, whether it is safe to apply.
|
||||
|
||||
Each card shows:
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Deploy Progress Modal
|
||||
title: Deploy Progress
|
||||
description: Stream live output from stack deploy, install, update, restart, and stop operations in a structured log view.
|
||||
---
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ Every Sencho release ships with a static list of capabilities. The current list
|
||||
| `global-logs` | Global log viewer (always available) |
|
||||
| `system-stats` | Host system statistics (always available) |
|
||||
| `fleet` | Fleet management view |
|
||||
| `auto-updates` | Auto-Update Readiness policies |
|
||||
| `auto-updates` | Auto-Update policies |
|
||||
| `labels` | Stack labels |
|
||||
| `webhooks` | Webhook triggers |
|
||||
| `network-topology` | Network topology view |
|
||||
|
||||
@@ -171,7 +171,7 @@ Store credentials for private Docker registries: Docker Hub organizations, GHCR,
|
||||
|
||||
## Automation
|
||||
|
||||
### Auto-Update Readiness
|
||||
### Auto-Update Policies
|
||||
|
||||
Review pending container updates across your fleet with risk badges (`Safe · patch`, `Review · minor`, `Blocked · major`, `Digest rebuild`) and one-line changelog previews on a single board. The hero counts pending updates and tells you how many are ready to apply without human review; stacks with a major version bump are surfaced as a separate count for review. Skipper or Admiral. [Learn more →](/features/auto-update-policies)
|
||||
|
||||
|
||||
@@ -359,4 +359,4 @@ The generic node-connectivity issues (a node showing Offline, a pilot agent stuc
|
||||
- [Multi-Node Management](/features/multi-node): the operator walkthrough for adding remote nodes in either mode, the Nodes table reference, and the cross-mode comparison.
|
||||
- [Sencho Mesh](/features/sencho-mesh): cross-node networking that rides on the pilot tunnel.
|
||||
- [Fleet view](/features/fleet-view): fleet-wide aggregation and node health across both modes.
|
||||
- [Security architecture](/security): credential model and trust posture across the rest of Sencho.
|
||||
- [Security architecture](/reference/security): credential model and trust posture across the rest of Sencho.
|
||||
|
||||
@@ -59,7 +59,7 @@ The All tasks toggle swaps the lane track for a sortable table.
|
||||
| Action | Target | What it does |
|
||||
|---|---|---|
|
||||
| **Restart Stack** | A specific stack (optionally specific services) on a specific node | Restarts all or selected containers in the stack. |
|
||||
| **Auto-update Stack** | A specific stack on a specific node | Checks each image in the stack for a newer tag and recreates the stack if any image has an update. See [Auto-Update Readiness](/features/auto-update-policies) for the companion review board. |
|
||||
| **Auto-update Stack** | A specific stack on a specific node | Checks each image in the stack for a newer tag and recreates the stack if any image has an update. See [Auto-Update Policies](/features/auto-update-policies) for the companion review board. |
|
||||
| **Auto-update All Stacks** | A specific node | Runs the auto-update check across every stack on the node that has auto-updates enabled. Stacks with auto-updates turned off are skipped. |
|
||||
| **Fleet Snapshot** | The whole fleet | Creates a versioned, fleet-wide snapshot of every node's compose files and `.env` files. See [Fleet Backups](/features/fleet-backups). |
|
||||
| **System Prune** | The selected node | Prunes containers, images, networks, and volumes (any subset), optionally filtered by a Docker label. |
|
||||
|
||||
Reference in New Issue
Block a user