Skip to content

Register docs into backstage with mkdocs file#30

Open
agaetep wants to merge 1 commit intomainfrom
agaete/mkdocs
Open

Register docs into backstage with mkdocs file#30
agaetep wants to merge 1 commit intomainfrom
agaete/mkdocs

Conversation

@agaetep
Copy link

@agaetep agaetep commented Mar 20, 2026

For docs to populate into backstage, an mkdocs.yml file must be present. I'm also just making sure that docs populate correctly with the auto-discovery feature

Signed-off-by: Antonia Gaete <agaete@linuxfoundation.org>
@agaetep agaetep requested a review from a team as a code owner March 20, 2026 19:56
Copilot AI review requested due to automatic review settings March 20, 2026 19:56
@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 701ed598-8ad8-4272-b995-e5b7f3fe023a

📥 Commits

Reviewing files that changed from the base of the PR and between d291c44 and 07422f5.

📒 Files selected for processing (1)
  • mkdocs.yml

Walkthrough

A new mkdocs.yml configuration file was added to define the documentation site settings for the LFX v2 Auth Service, including site name, description, and plugin configuration.

Changes

Cohort / File(s) Summary
Documentation Configuration
mkdocs.yml
Added new MkDocs configuration file defining site name ("LFX v2 Auth Service"), description, and enabling the techdocs-core plugin.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding an mkdocs.yml file to register documentation into Backstage, which matches the changeset's single addition of this configuration file.
Description check ✅ Passed The description is directly related to the changeset, explaining that an mkdocs.yml file is needed for Backstage documentation auto-discovery, which aligns with the file being added.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agaete/mkdocs

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a minimal mkdocs.yml configuration so the repository’s docs/ content can be discovered and built by Backstage TechDocs (via the techdocs-core plugin).

Changes:

  • Introduces root-level mkdocs.yml with site metadata.
  • Enables the techdocs-core MkDocs plugin for Backstage TechDocs generation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

site_name: LFX v2 Auth Service
site_description: Documentation for LFX v2 Auth Service
plugins:
- techdocs-core
Copy link

Copilot AI Mar 20, 2026

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.
@@ -0,0 +1,6 @@
# Copyright The Linux Foundation and each contributor to LFX.
Copy link

Copilot AI Mar 20, 2026

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.
@agaetep
Copy link
Author

agaetep commented Mar 20, 2026

Seems like docs are already populated with a default and minimal mkdocs.yaml file when one is not present. The mkdocs.yaml file in this PR is also minimal, so this may not be a necessary PR to merge unless we are wanting explicit definitions.

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.

2 participants