Skip to content

Register docs into backstage with mkdocs file #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agaetep wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Register docs into backstage with mkdocs file #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Copyright The Linux Foundation and each contributor to LFX.

Copilot AI Mar 20, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most YAML files in this repo include an SPDX header (e.g., # SPDX-License-Identifier: MIT) immediately after the copyright line. To match the established license-header convention (and avoid potential failures from the license-header-check workflow), add the SPDX line to this new mkdocs.yml as well.

Suggested change
# Copyright The Linux Foundation and each contributor to LFX.
# Copyright The Linux Foundation and each contributor to LFX.
# SPDX-License-Identifier: MIT

Copilot uses AI. Check for mistakes.
---
site_name: LFX v2 Auth Service
site_description: Documentation for LFX v2 Auth Service
plugins:
- techdocs-core

Copilot AI Mar 20, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MkDocs/TechDocs builds typically require a docs/index.md (default homepage). This repo’s docs/ directory currently has no index.md, so mkdocs build (and Backstage TechDocs generation) is likely to fail. Add docs/index.md (e.g., an overview linking to the existing pages) or explicitly configure docs_dir/nav to provide a homepage file.

Suggested change
- techdocs-core
- techdocs-core
nav:
- Home: README.md

Copilot uses AI. Check for mistakes.
Loading