Skip to content

🚀 Feature: Native Ingestion to DocsGPT with Backstage and Plugin #1293

@dartpain

Description

@dartpain

Summary

Implement a native integration within Backstage as a plugin to allow seamless data collection and ingestion from both private and public Git repositories into DocsGPT. This includes not only our private GitLab, but also aligns with Backstage's existing integration with git sources.

Background

We have a remote loader called GitHub. Backstage already facilitates integration with GitLab among other data sources.
Given Backstage's capabilities, we want to automatically collect and ingest data from it into DocsGPT by including docsgpt as a possible plugin

Requirements

  • Integration with GitLab: Craft a tailored integration using Backstage's GitLab integration features to connect efficiently with GitLab. Using the methods outlined similarly in this pull request as a guideline.
  • Data Ingestion: Ensure continuous data collection and ingestion into DocsGPT with scheduled remote uploads.
  • Plugin creation: Add docsgpt as a plugin option such that it can be published here https://backstage.io/plugins/

Tasks

  1. Review Backstage GitLab integration documentation to identify integration steps and configurations.
  2. Configure a GitLab entity provider in Backstage to fetch data effectively from the test GitLab project, ensuring it aligns with Backstage's existing capabilities.
  3. Configure app-config.yaml in Backstage
  4. Should include new frontend upload modal fields inside docsgpt.
  5. Test data collection and ingestion workflows using Backstage’s catalog and DocsGPT interfaces.
  6. Document the entire setup process and provide implementation guidelines for this action.
  7. Prepare a plugin for https://backstage.io/plugins/ backstages plugin directory use react web extension to natively integrate it into their frontend

References

Note: this will require both backend and frontend skills

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions