Skip to content

Fix MD060 table lint failures blocking the Docs pipeline #51

Description

The Docs workflow's Lint job runs super-linter, which executes markdownlint across the whole codebase. That job is currently failing on main.

Request

What happens

The Lint job fails with 36 MD060/table-column-style errors in two files. Because super-linter validates the entire codebase rather than only the changed files, every pull request inherits the red Lint check — even PRs that do not touch these files (for example #50).

File Table rows (lines) Errors
src/docs/Ways-of-Working/continuous-x-and-continuous-ai.md 10, 23, 76, 85 20
src/docs/Ways-of-Working/devops-reference.md 12, 60 16

The reported message is "Table pipe is missing space to the left/right for style 'compact'".

What is expected

The Lint job passes on main, and pull requests are no longer blocked by failures unrelated to their changes.

Regression

Introduced by 99d9d5a ("Add comprehensive guides on Continuous X practices, Development practices, and DevOps principles"). The two preceding commits (440b091, 8b20981) had a green Lint job. Evidence: the failing Docs run on main.

Acceptance criteria

  • The Docs Lint job passes on main.
  • Pull requests no longer inherit these MD060 failures.

Technical decisions

Root cause: The affected tables mix pipe spacing — header and body cells are padded (| # | Practice |) while the delimiter row is compact (|---|----------|). MD060/table-column-style requires a single consistent style per table. The markdownlint config at .github/linters/.markdown-lint.yml does not disable MD060, and it began being enforced after a super-linter/markdownlint version bump, so tables authored before the bump now fail.

Options:

  • Option A — reformat the tables (recommended). Make pipe spacing consistent (pad the delimiter rows to match the padded header/body cells) across the six flagged tables in the two files. Keeps MD060 active so future tables stay consistent. Small, contained change.
  • Option B — disable the rule. Add MD060: false to .github/linters/.markdown-lint.yml. This matches the config's existing pattern of disabling cosmetic rules (MD004, MD029, MD036, MD041, blank_lines) and is a one-line, repo-wide fix, but it stops enforcing table-column consistency.

MD060 concerns pipe spacing only and does not change how the tables render, so either option is safe. Option A is recommended for keeping the linter meaningful; Option B is the lower-effort alternative if enforcing table style is not wanted.


Implementation plan

Option A (recommended)

  • Reformat the tables in src/docs/Ways-of-Working/continuous-x-and-continuous-ai.md (rows 10, 23, 76, 85) for consistent pipe spacing
  • Reformat the tables in src/docs/Ways-of-Working/devops-reference.md (rows 12, 60) for consistent pipe spacing
  • Confirm the Docs Lint job reports 0 MD060 errors

Option B (alternative)

  • Add MD060: false to .github/linters/.markdown-lint.yml
  • Confirm the Docs Lint job passes

Discovered while working on #50, whose Lint check is red solely because of these pre-existing violations.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Fields

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