Giter Site home page Giter Site logo

Comments (4)

crivetechie avatar crivetechie commented on July 2, 2024 1

@t1agob docs look great, thank you!

from backstage-plugin-backend.

crivetechie avatar crivetechie commented on July 2, 2024

I have found out what I was missing to get the documented template to work:

create the file packages/backend/src/plugins/pagerduty.ts with following content:

import { createRouter } from '@pagerduty/backstage-plugin-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';

export default async function createPlugin(
  env: PluginEnvironment,
): Promise<Router> {
  return await createRouter({
    logger: env.logger,
    config: env.config,
  });
}

And then add to packages/backend/src/index.ts:

// In packages/backend/src/index.ts
import pagerduty from './plugins/pagerduty';
// ...
async function main() {
  // ...
  const pagerdutyEnv = useHotMemoize(module, () => createEnv('pagerduty'));
  // ...
  apiRouter.use('/pagerduty', await todo(pagerdutyEnv));

I'd recommend updating the instructions to setup the backend.
Some other plugins have similar instructions (as an example, see TODO: https://github.com/backstage/backstage/tree/master/plugins/todo)

from backstage-plugin-backend.

t1agob avatar t1agob commented on July 2, 2024

Hello @crivetechie!
Sorry for the trouble here. I totally missed this part in the documentation.

Adding it immediately and will tag you here if you want to review it before I close this issue.

from backstage-plugin-backend.

t1agob avatar t1agob commented on July 2, 2024

@crivetechie the documentation has been updated 👉🏼 https://pagerduty.github.io/backstage-plugin-docs/getting-started/backstage/#add-the-backend-plugin-to-your-application

Let me know if that looks good to you and I'll close the ticket. Feel free to suggest any additional changes.

from backstage-plugin-backend.

Related Issues (11)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.