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

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

Open
dartpain opened this issue Oct 10, 2024 · 1 comment
Open
Assignees
Labels
application Application backend enhancement New feature or request extensions Extensions hacktoberfest help wanted Extra attention is needed javascript Pull requests that update Javascript code python Pull requests that update Python code

Comments

@dartpain
Copy link
Contributor

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

@dartpain dartpain added enhancement New feature or request help wanted Extra attention is needed python Pull requests that update Python code javascript Pull requests that update Javascript code hacktoberfest application Application extensions Extensions backend labels Oct 10, 2024
@Charlesnorris509
Copy link

Hey I would like to be assigned with this issue I would investigate the Backstage for possible errors and possible enhancements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
application Application backend enhancement New feature or request extensions Extensions hacktoberfest help wanted Extra attention is needed javascript Pull requests that update Javascript code python Pull requests that update Python code
Projects
None yet
Development

No branches or pull requests

2 participants