From a1be1524a21bfa733942306c241f4bd017281793 Mon Sep 17 00:00:00 2001 From: Nitin Misra Date: Thu, 9 Apr 2026 11:02:43 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9A=20refactor(scout-cli):=20rename=20?= =?UTF-8?q?Platform=20=E2=86=92=20Scout=20Access=20and=20Open=20Source=20?= =?UTF-8?q?=E2=86=92=20OTel=20Config?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../index.md | 2 +- docs/getting-started.md | 6 ++-- docs/scout-cli/index.md | 30 +++++++++---------- docs/scout-cli/installation.md | 4 +-- .../_category_.json | 4 +-- .../config-init.md | 0 .../config-test.md | 0 .../config-validate.md | 0 .../reference/environment-variables.md | 8 ++--- docs/scout-cli/reference/global-flags.md | 2 +- .../_category_.json | 4 +-- .../{platform => scout-access}/alerts.md | 0 .../{platform => scout-access}/context.md | 0 .../{platform => scout-access}/login.md | 0 .../{platform => scout-access}/logout.md | 0 .../{platform => scout-access}/logs.md | 0 .../{platform => scout-access}/metrics.md | 0 .../{platform => scout-access}/service-map.md | 0 .../{platform => scout-access}/status.md | 0 .../{platform => scout-access}/traces.md | 0 .../{platform => scout-access}/tui.md | 0 21 files changed, 30 insertions(+), 30 deletions(-) rename docs/scout-cli/{open-source => otel-config}/_category_.json (76%) rename docs/scout-cli/{open-source => otel-config}/config-init.md (100%) rename docs/scout-cli/{open-source => otel-config}/config-test.md (100%) rename docs/scout-cli/{open-source => otel-config}/config-validate.md (100%) rename docs/scout-cli/{platform => scout-access}/_category_.json (77%) rename docs/scout-cli/{platform => scout-access}/alerts.md (100%) rename docs/scout-cli/{platform => scout-access}/context.md (100%) rename docs/scout-cli/{platform => scout-access}/login.md (100%) rename docs/scout-cli/{platform => scout-access}/logout.md (100%) rename docs/scout-cli/{platform => scout-access}/logs.md (100%) rename docs/scout-cli/{platform => scout-access}/metrics.md (100%) rename docs/scout-cli/{platform => scout-access}/service-map.md (100%) rename docs/scout-cli/{platform => scout-access}/status.md (100%) rename docs/scout-cli/{platform => scout-access}/traces.md (100%) rename docs/scout-cli/{platform => scout-access}/tui.md (100%) diff --git a/blog/2026-04-08-stop-deploying-broken-otel-configs/index.md b/blog/2026-04-08-stop-deploying-broken-otel-configs/index.md index 5e4c4b7..76da436 100644 --- a/blog/2026-04-08-stop-deploying-broken-otel-configs/index.md +++ b/blog/2026-04-08-stop-deploying-broken-otel-configs/index.md @@ -375,4 +375,4 @@ then run `scout config validate --file your-config.yaml`. command reference [prod-ready]: /blog/production-ready-otel-collector -[config-validate-docs]: /scout-cli/open-source/config-validate +[config-validate-docs]: /scout-cli/otel-config/config-validate diff --git a/docs/getting-started.md b/docs/getting-started.md index a2474b8..d75a151 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -49,9 +49,9 @@ for a quick win and a clear next step. ## I want to use the CLI - [Install Scout CLI](/scout-cli/installation) -- [Generate an OTel Collector config](/scout-cli/open-source/config-init) -- [Validate a collector config](/scout-cli/open-source/config-validate) -- [Query logs, traces, and metrics](/scout-cli/platform/logs) +- [Generate an OTel Collector config](/scout-cli/otel-config/config-init) +- [Validate a collector config](/scout-cli/otel-config/config-validate) +- [Query logs, traces, and metrics](/scout-cli/scout-access/logs) ## I want CI/CD observability diff --git a/docs/scout-cli/index.md b/docs/scout-cli/index.md index addcfb2..fa1297c 100644 --- a/docs/scout-cli/index.md +++ b/docs/scout-cli/index.md @@ -21,32 +21,32 @@ Scout platform to query logs, metrics, traces, alerts, and service topology — use the open-source config commands to validate, generate, and test OpenTelemetry Collector configurations without a backend. -## Platform Commands +## Scout Access These commands require authentication with a [Scout](https://base14.io) backend. | Command | Description | |---------|-------------| -| [login](./platform/login.md) | Authenticate with the Scout platform | -| [logout](./platform/logout.md) | Remove stored credentials | -| [status](./platform/status.md) | Check authentication status | -| [context](./platform/context.md) | Manage multiple account contexts | -| [alerts](./platform/alerts.md) | Query alert history | -| [logs](./platform/logs.md) | Query service logs | -| [metrics](./platform/metrics.md) | Query service metrics | -| [traces](./platform/traces.md) | Query distributed traces | -| [service-map](./platform/service-map.md) | Visualize service topology | - -## Open Source Commands +| [login](./scout-access/login.md) | Authenticate with the Scout platform | +| [logout](./scout-access/logout.md) | Remove stored credentials | +| [status](./scout-access/status.md) | Check authentication status | +| [context](./scout-access/context.md) | Manage multiple account contexts | +| [alerts](./scout-access/alerts.md) | Query alert history | +| [logs](./scout-access/logs.md) | Query service logs | +| [metrics](./scout-access/metrics.md) | Query service metrics | +| [traces](./scout-access/traces.md) | Query distributed traces | +| [service-map](./scout-access/service-map.md) | Visualize service topology | + +## OTel Config These commands work entirely offline with no Scout account required. | Command | Description | |---------|-------------| -| [config validate](./open-source/config-validate.md) | Validate an OTel Collector YAML config | -| [config init](./open-source/config-init.md) | Generate a production-ready OTel Collector config | -| [config test](./open-source/config-test.md) | Live-test an OTel Collector config | +| [config validate](./otel-config/config-validate.md) | Validate an OTel Collector YAML config | +| [config init](./otel-config/config-init.md) | Generate a production-ready OTel Collector config | +| [config test](./otel-config/config-test.md) | Live-test an OTel Collector config | :::tip No account needed The `scout config` commands are fully open source. You can validate, generate, diff --git a/docs/scout-cli/installation.md b/docs/scout-cli/installation.md index e54c9c9..22b1e8f 100644 --- a/docs/scout-cli/installation.md +++ b/docs/scout-cli/installation.md @@ -34,7 +34,7 @@ scout --version ## Next Steps -- **Platform users** — [Authenticate with Scout](./platform/login.md) to start +- **Platform users** — [Authenticate with Scout](./scout-access/login.md) to start querying telemetry data -- **Open-source users** — [Generate an OTel Collector config](./open-source/config-init.md) +- **Open-source users** — [Generate an OTel Collector config](./otel-config/config-init.md) to get started without a backend diff --git a/docs/scout-cli/open-source/_category_.json b/docs/scout-cli/otel-config/_category_.json similarity index 76% rename from docs/scout-cli/open-source/_category_.json rename to docs/scout-cli/otel-config/_category_.json index 66f87cd..f598289 100644 --- a/docs/scout-cli/open-source/_category_.json +++ b/docs/scout-cli/otel-config/_category_.json @@ -1,10 +1,10 @@ { - "label": "Open Source Commands", + "label": "OTel Config", "position": 4, "collapsed": false, "link": { "type": "generated-index", - "title": "Open Source Commands", + "title": "OTel Config", "description": "Offline commands for validating, generating, and testing OpenTelemetry Collector configurations. No Scout backend required." } } diff --git a/docs/scout-cli/open-source/config-init.md b/docs/scout-cli/otel-config/config-init.md similarity index 100% rename from docs/scout-cli/open-source/config-init.md rename to docs/scout-cli/otel-config/config-init.md diff --git a/docs/scout-cli/open-source/config-test.md b/docs/scout-cli/otel-config/config-test.md similarity index 100% rename from docs/scout-cli/open-source/config-test.md rename to docs/scout-cli/otel-config/config-test.md diff --git a/docs/scout-cli/open-source/config-validate.md b/docs/scout-cli/otel-config/config-validate.md similarity index 100% rename from docs/scout-cli/open-source/config-validate.md rename to docs/scout-cli/otel-config/config-validate.md diff --git a/docs/scout-cli/reference/environment-variables.md b/docs/scout-cli/reference/environment-variables.md index e3daae9..8f2d372 100644 --- a/docs/scout-cli/reference/environment-variables.md +++ b/docs/scout-cli/reference/environment-variables.md @@ -21,20 +21,20 @@ environment variables when both are set. | Variable | Description | Default | Used By | |----------|-------------|---------|---------| -| `SCOUT_ACCOUNT_SLUG` | Default account slug | — | [login](../platform/login.md) | -| `SCOUT_AUTH_URL` | Authentication server URL | `https://id.base14.io` | [login](../platform/login.md) | +| `SCOUT_ACCOUNT_SLUG` | Default account slug | — | [login](../scout-access/login.md) | +| `SCOUT_AUTH_URL` | Authentication server URL | `https://id.base14.io` | [login](../scout-access/login.md) | ## API | Variable | Description | Default | Used By | |----------|-------------|---------|---------| | `SCOUT_API_URL` | Override the Scout API base URL | Auto-discovered on login | All platform commands | -| `SCOUT_ACCOUNTS_API_URL` | Override the accounts discovery API URL | `https://api.base14.io` | [login](../platform/login.md) | +| `SCOUT_ACCOUNTS_API_URL` | Override the accounts discovery API URL | `https://api.base14.io` | [login](../scout-access/login.md) | ## OTel Collector Authentication These variables are referenced in configs generated by -[`scout config init`](../open-source/config-init.md): +[`scout config init`](../otel-config/config-init.md): | Variable | Description | |----------|-------------| diff --git a/docs/scout-cli/reference/global-flags.md b/docs/scout-cli/reference/global-flags.md index 2a29360..5ca8e83 100644 --- a/docs/scout-cli/reference/global-flags.md +++ b/docs/scout-cli/reference/global-flags.md @@ -57,4 +57,4 @@ scout -v logs payment-service --raw 2>debug.log | jq . - [Environment Variables](./environment-variables.md) — configure Scout CLI via environment -- [context](../platform/context.md) — manage account contexts persistently +- [context](../scout-access/context.md) — manage account contexts persistently diff --git a/docs/scout-cli/platform/_category_.json b/docs/scout-cli/scout-access/_category_.json similarity index 77% rename from docs/scout-cli/platform/_category_.json rename to docs/scout-cli/scout-access/_category_.json index 98e2cf8..2fa8863 100644 --- a/docs/scout-cli/platform/_category_.json +++ b/docs/scout-cli/scout-access/_category_.json @@ -1,10 +1,10 @@ { - "label": "Platform Commands", + "label": "Scout Access", "position": 3, "collapsed": false, "link": { "type": "generated-index", - "title": "Platform Commands", + "title": "Scout Access", "description": "Commands that interact with the Scout backend for authentication, querying telemetry data, and managing account contexts." } } diff --git a/docs/scout-cli/platform/alerts.md b/docs/scout-cli/scout-access/alerts.md similarity index 100% rename from docs/scout-cli/platform/alerts.md rename to docs/scout-cli/scout-access/alerts.md diff --git a/docs/scout-cli/platform/context.md b/docs/scout-cli/scout-access/context.md similarity index 100% rename from docs/scout-cli/platform/context.md rename to docs/scout-cli/scout-access/context.md diff --git a/docs/scout-cli/platform/login.md b/docs/scout-cli/scout-access/login.md similarity index 100% rename from docs/scout-cli/platform/login.md rename to docs/scout-cli/scout-access/login.md diff --git a/docs/scout-cli/platform/logout.md b/docs/scout-cli/scout-access/logout.md similarity index 100% rename from docs/scout-cli/platform/logout.md rename to docs/scout-cli/scout-access/logout.md diff --git a/docs/scout-cli/platform/logs.md b/docs/scout-cli/scout-access/logs.md similarity index 100% rename from docs/scout-cli/platform/logs.md rename to docs/scout-cli/scout-access/logs.md diff --git a/docs/scout-cli/platform/metrics.md b/docs/scout-cli/scout-access/metrics.md similarity index 100% rename from docs/scout-cli/platform/metrics.md rename to docs/scout-cli/scout-access/metrics.md diff --git a/docs/scout-cli/platform/service-map.md b/docs/scout-cli/scout-access/service-map.md similarity index 100% rename from docs/scout-cli/platform/service-map.md rename to docs/scout-cli/scout-access/service-map.md diff --git a/docs/scout-cli/platform/status.md b/docs/scout-cli/scout-access/status.md similarity index 100% rename from docs/scout-cli/platform/status.md rename to docs/scout-cli/scout-access/status.md diff --git a/docs/scout-cli/platform/traces.md b/docs/scout-cli/scout-access/traces.md similarity index 100% rename from docs/scout-cli/platform/traces.md rename to docs/scout-cli/scout-access/traces.md diff --git a/docs/scout-cli/platform/tui.md b/docs/scout-cli/scout-access/tui.md similarity index 100% rename from docs/scout-cli/platform/tui.md rename to docs/scout-cli/scout-access/tui.md