docs: Backstage catalog compliance + TechDocs - #7
Merged
Conversation
- catalog-info.yaml: add required fluentinhealth.com/service-assessment annotation
(client-SDK values: auth=none, permissions=unspecified, security=none) and
backstage.io/techdocs-ref so docs render in Backstage TechDocs
- Add TechDocs: mkdocs.yml (techdocs-core) + docs/{index,usage,data-sync}.md
Note: owner is group:default/engineering (skill-permitted default; unverified against
the live catalog). The descriptor must also be registered in the org root catalog-info.yaml
(in the backstage repo) before Backstage discovers it.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…dopters Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes the repo Backstage-compatible on both fronts.
Software catalog (
catalog-info.yaml)fluentinhealth.com/service-assessmentannotation (renders the security-posture card). Client-SDK values:auth=none,permissions=unspecified,security=none, with an exception note that it's a client-side library with no server/auth surface.backstage.io/techdocs-ref: dir:.so TechDocs renders.backstage.io/kubernetes-id(no deployment) andfluentinhealth.com/apim-logs(no APIM presence).TechDocs
mkdocs.yml(with thetechdocs-coreplugin) +docs/: Home, Usage, Data synchronization — so the docs render inside Backstage, not just as a README.Follow-ups (not in this repo)
group:default/engineering(the skill-permitted default) — unverified against the live catalog; confirm if needed.catalog-info.yaml(in the backstage repo) before Backstage picks it up — a one-lineLocationtarget addition there.🤖 Generated with Claude Code