Skip to content
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.

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

Documentation improvements: Missing Plugin registration part. #4

Open
knowacki23 opened this issue Aug 30, 2024 · 0 comments
Open

Documentation improvements: Missing Plugin registration part. #4

knowacki23 opened this issue Aug 30, 2024 · 0 comments

Comments

@knowacki23
Copy link
Contributor

Hey,
I've found one missing part in the documentation on how to setup a plugin.
In order to get the data from app-config.yaml file, the gitpod.baseUrl variable to be precise, you need to register the plugin first.

To register a frontend-plugin you need to add it to your packages/app/src/App.tsx file like so:

+ import { GitpodPlugin } from "@gitpod/backstage-plugin-gitpod";

const app = createApp({
  apis,
+  plugins: [GitpodPlugin],
  components: {
    SignInPage: (...),
  },
  bindRoutes({ bind }) {
    (...)
  },
(...)
});

Then the Gitpod plugin will be able to read the custom Gitpod URL string from app-config.yaml.

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

No branches or pull requests

1 participant