Skip to content

docs: Add Backstage plugin integration documentation#6755

Merged
talissoncosta merged 13 commits intomainfrom
docs/add-backstage-plugin-documentation
Feb 24, 2026
Merged

docs: Add Backstage plugin integration documentation#6755
talissoncosta merged 13 commits intomainfrom
docs/add-backstage-plugin-documentation

Conversation

@talissoncosta
Copy link
Contributor

@talissoncosta talissoncosta commented Feb 23, 2026

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Added comprehensive documentation for the Flagsmith Backstage plugin integration:

  • Created new documentation page at docs/docs/third-party-integrations/backstage/backstage.md
  • Added "Developer Tools" section to integrations index page
  • Includes installation, configuration, and usage instructions
  • Covers all three components: Feature Flags Tab, Overview Card, and Usage Card

How did you test this code?

  • Documentation builds locally without errors
  • Follows existing integration documentation patterns (Jira, Slack, Datadog)
  • All code examples are syntactically correct
  • Verified markdown rendering at /third-party-integrations/backstage

Closes #6621

@vercel
Copy link

vercel bot commented Feb 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 24, 2026 10:39pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Feb 24, 2026 10:39pm
flagsmith-frontend-staging Ignored Ignored Preview Feb 24, 2026 10:39pm

Request Review

@github-actions github-actions bot added the docs Documentation updates label Feb 23, 2026
@talissoncosta talissoncosta changed the title docs: Add Backstage plugin integration documentation docs: add Backstage plugin integration documentation Feb 23, 2026
@talissoncosta talissoncosta marked this pull request as ready for review February 23, 2026 18:12
@talissoncosta talissoncosta requested a review from a team as a code owner February 23, 2026 18:12
@talissoncosta talissoncosta requested review from adamvialpando and removed request for a team February 23, 2026 18:12
@cursor
Copy link

cursor bot commented Feb 23, 2026

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on March 10.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

Add comprehensive documentation for the Flagsmith Backstage plugin integration, including:
- Overview of plugin components (Feature Flags Tab, Overview Card, Usage Card)
- Prerequisites and installation instructions
- Configuration setup with proxy endpoints
- Step-by-step guide for adding components to entity pages
- Entity annotation reference
- Instructions for obtaining credentials (Admin API Key, Project ID, Organisation ID)
- Example screenshots demonstrating plugin functionality

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@talissoncosta talissoncosta force-pushed the docs/add-backstage-plugin-documentation branch from 8c6c1b4 to 2c56f9f Compare February 23, 2026 23:15
@talissoncosta talissoncosta changed the title docs: add Backstage plugin integration documentation docs: Add Backstage plugin integration documentation Feb 23, 2026
- Use consistent markdown image syntax instead of HTML img tags
- Correct Admin API Key location to Organisation Settings
- Add instructions about enabling JSON references for IDs
- Clarify Master API Key terminology

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The org-id annotation is no longer required as it's automatically derived
from the project data by the plugin (see Flagsmith/flagsmith-backstage-plugin#22).

Changes:
- Removed org-id from Prerequisites
- Removed org-id from Entity Annotations example and table
- Added tip explaining automatic org-id derivation
- Removed Organisation ID section from Getting Your Credentials

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Change "management" to "observability" since plugin is view-only
- Improve Feature Flags Tab description to be more specific
- Update index page to use "observability" terminology

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 24, 2026

Deployment failed with the following error:

Creating the Deployment Timed Out.

Added screenshot showing flag details expanded with graphs as suggested
by review feedback.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@talissoncosta
Copy link
Contributor Author

Thanks for the review @asaphko
I've added a screenshot

Screenshot 2026-02-24 at 14 18 46

Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

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

Looks good, but needs a bit of polishing.

- Rename backstage directory to developer-tools for better organization
- Update title from "Backstage" to "Backstage Plugin" for clarity
- Creates expandable "Developer Tools" category in sidebar with "Backstage Plugin" as child item

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Per emyller's feedback, reorganize Backstage plugin documentation:
- Move from developer-tools/ to additional-integrations/ directory
- Update index.mdx to show Backstage under "Additional Integrations"
- Remove "Developer Tools" section from index page
- Backstage now appears alongside Webhook in Additional Integrations

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
emyller
emyller previously approved these changes Feb 24, 2026
Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

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

LGTM!

matthewelwell
matthewelwell previously approved these changes Feb 24, 2026
@talissoncosta talissoncosta merged commit 911d6ce into main Feb 24, 2026
12 checks passed
@talissoncosta talissoncosta deleted the docs/add-backstage-plugin-documentation branch February 24, 2026 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for Backstage plugin

4 participants