Skip to content

Documentation improvements: Missing Plugin registration part. #4

@knowacki23

Description

@knowacki23

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions