Add deprecation guide for display labels

[BaptisteGi]

Preview = https://bgi-migration-guide-display.infrahub.pages.dev/release-notes/deprecation-guides/display_labels

Summary by CodeRabbit

Release Notes

• Documentation
  • Added deprecation guide for migrating from display_labels to display_label with step-by-step instructions and examples
  • Updated documentation sidebar with new Deprecation Guides section

[coderabbitai]

Walkthrough

This pull request introduces a deprecation guide for migrating from the display_labels attribute to display_label. The changes include creating a new documentation file that provides migration context, step-by-step rules, and examples for single and multiple attribute references. A new Deprecation Guides category has been added to the documentation sidebar to organize this content. Additionally, a spelling exception entry for "display_label" has been added to the spelling exceptions configuration.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Add deprecation guide for display labels" accurately captures the primary change in this changeset. The main objective is the introduction of a new deprecation guide documentation file (display_labels.mdx) that guides users on migrating from display_labels to display_label. The supporting changes—adding a spelling exception and updating the documentation sidebar—are necessary infrastructure to enable and surface this guide. The title is concise, specific, and clearly communicates the primary intent without vagueness or misleading information.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bgi-migration-guide-display-labels

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/docs/release-notes/deprecation-guides/display_labels.mdx (1)

1-11: Consider linking to specific version release notes.

The introduction is clear and well-structured. However, the release notes link on line 7 (and line 159) points to the generic releases page. Consider linking directly to the Infrahub 1.5 release notes for easier access to relevant information.

Apply this diff to make the links more specific:

-Learn more about this change in the [release notes](https://github.com/opsmill/infrahub/releases).
+Learn more about this change in the [Infrahub 1.5 release notes](https://github.com/opsmill/infrahub/releases/tag/v1.5.0).

And at line 159:

-- [Release notes for Infrahub 1.5](https://github.com/opsmill/infrahub/releases)
+- [Release notes for Infrahub 1.5](https://github.com/opsmill/infrahub/releases/tag/v1.5.0)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47c93e3 and 353cdb7.

📒 Files selected for processing (3)

• .vale/styles/spelling-exceptions.txt (1 hunks)
• docs/docs/release-notes/deprecation-guides/display_labels.mdx (1 hunks)
• docs/sidebars.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

docs/**/*.mdx

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Use Docusaurus markdown/MDX features in documentation

docs/**/*.mdx: How-to guides should begin title with "How to..." and follow the Diataxis How-to structure (intro, prerequisites, step-by-step, validation, advanced, related)
Use imperative, task-focused instructions in guides; avoid digressions
Topics should use titles like "About..." or "Understanding..." and follow the Diataxis Topics structure (concepts, background, architecture, mental models, connections, alternatives, further reading)
Define new terms on first use; prefer domain-relevant terminology; keep naming consistent with Infrahub UI/data model

Files:

• docs/docs/release-notes/deprecation-guides/display_labels.mdx

docs/**/*

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Develop documentation in docs/, preview with invoke docs.build docs.serve, and validate with invoke docs.validate

Files:

• docs/docs/release-notes/deprecation-guides/display_labels.mdx
• docs/sidebars.ts

**/*.mdx

📄 CodeRabbit inference engine (.github/instructions/documentation.instructions.md)

**/*.mdx: Structure documentation primarily as How-to Guides and Topics (explanations) following the Diataxis framework
Use a professional, approachable tone; avoid jargon unless defined; use plain language with technical precision
Write concise, direct, active sentences
Be informative over promotional; focus on explaining how and why
Maintain consistent, predictable structure across sections and documents
For Guides: use conditional imperatives (e.g., "If you want X, do Y")
For Guides: focus on practical tasks and problems, not tools
For Guides: address the user directly with imperative verbs (e.g., "Configure...", "Create...")
For Guides: keep focus on the specific goal; avoid digressions into explanations
For Guides: title in YAML frontmatter should clearly state the problem and begin with "How to..."
For Guides: include an Introduction stating the problem/goal, context, and what the user will achieve
For Guides: include a Prerequisites/Assumptions section listing requirements and prior knowledge
For Guides: provide step-by-step instructions with numbered steps; include code snippets/screenshots/tabs/callouts as needed
For Guides: include a Validation/Verification section with checks, example outputs, and potential failure points
For Guides: include a Related Resources section linking to relevant guides/topics/reference
For Topics: title in YAML frontmatter should clearly indicate the topic; consider starting with "About..." or "Understanding..."
For Topics: include an Introduction with overview, why it matters, and questions answered
For Topics: include sections for Concepts & Definitions
For Topics: include Background & Context (history, design rationale, constraints)
For Topics: include Architecture & Design details/diagrams when applicable
For Topics: include Mental Models (analogies/comparisons)
For Topics: connect to other concepts and integration points
For Topics: include Alternative Approaches with pros/cons where relevant
For Topics: include a Further...

Files:

• docs/docs/release-notes/deprecation-guides/display_labels.mdx

**/*.{md,mdx}

📄 CodeRabbit inference engine (CLAUDE.md)

Lint Markdown/MDX files with markdownlint using .markdownlint.yaml

Files:

• docs/docs/release-notes/deprecation-guides/display_labels.mdx

docs/!(node_modules)/**/*.{md,mdx}

📄 CodeRabbit inference engine (CLAUDE.md)

docs/!(node_modules)/**/*.{md,mdx}: Lint documentation prose with Vale
Ensure Vale style checks pass for documentation

Files:

• docs/docs/release-notes/deprecation-guides/display_labels.mdx

🪛 LanguageTool

docs/docs/release-notes/deprecation-guides/display_labels.mdx

[style] ~10-~10: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ances that were migrated from a version prior to 1.5. If you're starting with Infrahub 1...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

---

[style] ~19-~19: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... AI assisted refactoring Feel free to use this prompt with your preferred cod...

(FEEL_FREE_TO_STYLE_ME)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (5)

.vale/styles/spelling-exceptions.txt (1)

55-55: LGTM!

The spelling exception for display_label is correctly placed and aligns with the new feature being documented.

docs/sidebars.ts (1)

490-500: LGTM!

The new "Deprecation Guides" category is well-structured and follows existing sidebar patterns. The placement under Release Notes is logical and makes this content easy to discover.

docs/docs/release-notes/deprecation-guides/display_labels.mdx (3)

17-80: Great addition for developer experience!

The collapsible AI-assisted refactoring prompt is an innovative and practical addition that will help users automate the migration process. The prompt is comprehensive, with clear rules and examples.

---

86-128: LGTM!

The migration patterns are well-organized with clear before/after examples. The progression from simple to complex cases (single attribute → multiple attributes → relationships) makes this easy to follow.

---

129-155: LGTM!

Step 2 provides clear, actionable instructions for both Git-based and local schema management workflows. The validation commands and success criteria help users confirm their migration is complete.