Skip to content

Broken link in docs/tips.md: /templates/rails.yml 404s on the docs site #349

@justin808

Description

@justin808

Problem

docs/tips.md has a broken link that 404s on the docs site (https://controlplaneflow.com) and is flagged by the Docusaurus build as a broken link.

Location: docs/tips.md, in the "Scale the Web Workload to Zero" section (around line 247):

See [`templates/rails.yml`](/templates/rails.yml) for the full default — `containers`, `firewallConfig`, ...

The link target /templates/rails.yml is repo-root-relative. On the published docs site it resolves to https://controlplaneflow.com/templates/rails.yml, which does not exist (the site only serves /docs/* and a few static assets). It also does not reliably resolve on github.com.

The file itself is real and lives at templates/rails.yml in this repo.

Suggested fix

Point the link at the canonical file with an absolute GitHub URL so it works both on github.com and on the synced docs site:

See [`templates/rails.yml`](https://github.com/shakacode/control-plane-flow/blob/main/templates/rails.yml) for the full default ...

(The other mentions of templates/rails.yml at lines ~224/226/231/233 are plain text, not links, so they're fine.)

Context

Found while building the docs site (shakacode/controlplaneflow-com#2). The site build currently passes with onBrokenLinks: 'warn', so this surfaces as a warning:

[WARNING] Docusaurus found broken links!
- Broken link on source page path = /docs/tips:
   -> linking to /templates/rails.yml

Alternative: the docs site (controlplaneflow-com) could rewrite repo-root-relative paths to the upstream GitHub blob in its sync transform (scripts/docs-links.mjs), but fixing the link at the source is cleaner and also fixes it on github.com.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions