docs(code-samples): fix JSON syntax, docker build context, and Prometheus scheme#1244
docs(code-samples): fix JSON syntax, docker build context, and Prometheus scheme#1244ekline[bot] wants to merge 1 commit into
Conversation
…heus scheme Fix three factual inaccuracies in documentation code samples: - reference/okteto-manifest.mdx: remove trailing comma in JSON array (invalid JSON syntax that causes parse errors) - admin/custom-installer-image.mdx: add missing build context (`.`) to `docker build` command (command fails without it) - admin/okteto-insights.mdx: change Prometheus scraper scheme from `http` to `https` (endpoint is TLS-terminated behind NGINX Ingress) Also applies style improvements from automated review: replaces "available here" link patterns with descriptive inline links, removes banned words, fixes terminology capitalization, and corrects typos. Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
ekline
Bot
requested review from
codyjlandstrom,
ifbyol,
pchico83 and
rlamana
as code owners
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![ekline[bot]](https://avatars.githubusercontent.com/in/1173463?s=60&v=4){kind=small}
| "https://raw.githubusercontent.com/okteto/okteto/master/schema.json": [ | ||
| "okteto.yml", | ||
| "okteto.yaml", | ||
| "okteto.yaml" |
There was a problem hiding this comment.
Finding: Trailing comma after "okteto.yaml" made this invalid JSON. While VS Code's settings.json uses JSONC (which tolerates trailing commas), the code fence is labeled json and would fail in any strict JSON parser.
Source: JSON specification (RFC 8259) — arrays must not have trailing commas.
|
|
||
| ```bash | ||
| docker build -t REGISTRY/REPOSITORY:TAG | ||
| docker build -t REGISTRY/REPOSITORY:TAG . |
There was a problem hiding this comment.
Finding: docker build -t REGISTRY/REPOSITORY:TAG was missing the required build context argument. Without it, Docker exits with: "docker build requires exactly 1 argument".
Source: Docker CLI reference — docker build requires a PATH or URL as the build context.
| scrape_timeout: 30s | ||
|
|
||
| scheme: http | ||
| scheme: https |
There was a problem hiding this comment.
Finding: Prometheus scraper was configured with scheme: http targeting port 443. The Okteto API endpoint is TLS-terminated behind NGINX Ingress (confirmed via app/backend/cmd/api.go and the Helm chart's ingress TLS configuration). Prometheus would fail with a TLS handshake error when attempting plain HTTP against an HTTPS endpoint.
Source: Okteto Helm chart config (OKTETO_INGRESS_TLS_SECRET_NAME) and backend API server registration at /metrics.
Summary
This PR fixes factual inaccuracies in documentation code samples, verified against the current API and SDK signatures. Cosmetic and stylistic changes are intentionally out of scope.
Scan summary: 145 doc files scanned across all content directories. 3 files with High findings, 3 files fixed, 0 deferred.
Fixes
Style improvements from automated review were also applied: descriptive inline link text, banned word removal, terminology fixes, and typo corrections.
Test plan