Skip to content

Backstage Plugin overview.#3913

Merged
bigkevmcd merged 9 commits intomainfrom
backstage-plugin
Sep 13, 2023
Merged

Backstage Plugin overview.#3913
bigkevmcd merged 9 commits intomainfrom
backstage-plugin

Conversation

@bigkevmcd
Copy link
Copy Markdown
Contributor

Closes

What changed?
This provides a brief introduction to the Backstage Plugin for Flux.

It references the plugin README as the primary source for installation instructions.

Why was this change made?
To provide simple documentation on the Backstage plugin

How was this change implemented?
Documentation

How did you validate the change?

Release notes

Documentation Changes

This provides a brief introduction to the Backstage Plugin for Flux.

It references the plugin README as the primary source for installation
instructions.
@lasomethingsomething lasomethingsomething added the user-guide Improvements to docs at https://docs.gitops.weave.works/ label Aug 7, 2023
Comment thread website/docs/backstage/intro.mdx Outdated
Comment thread website/docs/backstage/intro.mdx Outdated
Comment thread website/docs/backstage/intro.mdx Outdated
Currently, the Backstage plugin provides the following components:

- EntityFluxDeploymentsCard - shows a combined view of HelmReleases and Kustomizations
- EntityFluxSourcesCard - shows a combined view of GitRepositories, OCIRepositories and HelmRepositories
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- EntityFluxSourcesCard - shows a combined view of GitRepositories, OCIRepositories and HelmRepositories
- EntityFluxSourcesCard - shows a combined view of GitRepositories, OCIRepositories, and HelmRepositories

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not sure a comma is needed here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's a US English grammar norm, feel free to disregard.

- EntityFluxOCIRepositoriesCard
- EntityFluxHelmRepositoriesCard

For example, to add the `EntityFluxHelmReleasesCard` to your Entity home page for components with the `backstage.io/kubernetes-id` entity annotation.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This sentence feels unfinished? Specifically, "For example, to add...": the "to add" clause isn't closed.

Comment thread website/docs/backstage/intro.mdx Outdated
Comment thread website/docs/backstage/intro.mdx Outdated
Comment thread website/docs/backstage/intro.mdx Outdated
bigkevmcd and others added 6 commits August 7, 2023 13:04
Co-authored-by: Lauri Apple <lauri@weave.works>
Co-authored-by: Lauri Apple <lauri@weave.works>
Co-authored-by: Lauri Apple <lauri@weave.works>
Co-authored-by: Lauri Apple <lauri@weave.works>
Co-authored-by: Lauri Apple <lauri@weave.works>
Co-authored-by: Lauri Apple <lauri@weave.works>
title: Backstage Plugin for Flux
---

Are you running [Backstage](https://backstage.io) and [Flux](https://fluxcd.io)? Do you want to expose the state of your Flux resources in your Backstage portal?
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔥

Copy link
Copy Markdown
Contributor

@foot foot left a comment

Choose a reason for hiding this comment

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

🏅 LGTM

@bigkevmcd bigkevmcd enabled auto-merge (squash) August 22, 2023 13:46
@bigkevmcd bigkevmcd merged commit 2f45c8d into main Sep 13, 2023
@bigkevmcd bigkevmcd deleted the backstage-plugin branch September 13, 2023 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

user-guide Improvements to docs at https://docs.gitops.weave.works/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants