Skip to content

Remove stale TechDocs annotation from metadata.yaml#172

Closed
ChrisMera wants to merge 1 commit into
masterfrom
cmera/remove-stale-techdocs-annotation
Closed

Remove stale TechDocs annotation from metadata.yaml#172
ChrisMera wants to merge 1 commit into
masterfrom
cmera/remove-stale-techdocs-annotation

Conversation

@ChrisMera

Copy link
Copy Markdown
Contributor

Summary

  • Removes the leftover backstage.io/techdocs-ref: dir:. annotation (and the now-empty annotations: block) from metadata.yaml. TechDocs was added in rshakespear/speed-3253-techdocs-guardrail #170 and reverted in Revert "rshakespear/speed-3253-techdocs-guardrail" #171, but this annotation was left behind, so guardrail still shows up in the Backstage Docs index despite having no docs.
  • Repo-wide search confirms no other TechDocs/mkdocs remnants (no mkdocs.yml, no CI build steps). docs/plugins.md was reviewed and kept — it's genuine plugin documentation linked from the README, not an mkdocs artifact.

Notes

  • After merge, the Backstage catalog picks this up on its regular sync; to see it immediately, hit refresh on the guardrail entity's About card in Backstage.
  • Cleaning up stale built docs in the TechDocs S3 bucket is out of scope.

Test plan

  • metadata.yaml parses as valid YAML; kind/name/spec fields unchanged
  • grep -i techdocs returns nothing repo-wide

TechDocs was added in #170 and reverted in #171, but the
backstage.io/techdocs-ref annotation was left behind, causing guardrail
to still appear in the Backstage Docs index despite having no docs.
@ChrisMera
ChrisMera requested a review from a team as a code owner July 13, 2026 20:28
@ChrisMera

Copy link
Copy Markdown
Contributor Author

Superseded by #173 (same change, moved to branch cmera/SPEED-3390).

@ChrisMera ChrisMera closed this Jul 13, 2026
@ChrisMera
ChrisMera deleted the cmera/remove-stale-techdocs-annotation branch July 13, 2026 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant