/backstage-stackoverflow

Stack Overflow for Teams integration with Backstage

Primary LanguageTypeScript

Backstage - Stack Overflow for Teams Plugin

Overview

The Stack Overflow for Teams plugins for Backstage integrate your private knowledge solution with your Backstage instance. These plugins provide seamless access to Stack Overflow Teams' most relevant data, allowing you to display the top users, top tags, and top questions directly within Backstage. Additionally, it indexes all the questions from a Stack Overflow instance and integrates them into Backstage search, providing enhanced discoverability.

These plugins also allow you to securely create Stack Overflow for Teams questions from Backstage itself.

Key Features

Top Users and Tags

Displays the top users and tags from your Stack Overflow instance, giving you insights into the most active contributors and trending topics.

alt text alt text

Question Indexing

Retrieves all the questions from your Stack Overflow instance and indexes them into Backstage search. This makes it easier to search and discover questions across your organization.

alt text

Stack Overflow Hub

A centralized hub within Backstage that showcases the top questions. The hub also allows you to filter questions like you would on Stack Overflow.

alt text

OAuth Authentication for Secure Question Creation

One of the most exciting features of this plugin is the ability to securely create questions on your Stack Overflow instance directly from Backstage using OAuth. The authentication process is secure, ensuring that only authorized users can post questions, and it is designed to seamlessly integrate with Backstage.

alt text

Installation

Follow these steps to install and run the plugin locally:

  1. Clone the repository

  2. Navigate into the project directory:

    cd backstage-stackoverflow
    
  3. Install dependencies:

    yarn install
    
  4. The installation will scaffold the Backstage application and include the necessary plugins.

  5. The plugins this project aims to develop are located in the /plugins folder. Changes to the code will usually trigger a hot reload. If not, you can restart the Backstage application.

  6. To start the Backstage application, run:

    yarn dev
    

Contributing

Feel free to fork this repository and submit pull requests. Contributions, suggestions, and bug reports are welcome!