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

MVP Roadmap #30

Open
43 tasks done
UlisesGascon opened this issue Dec 5, 2024 · 3 comments
Open
43 tasks done

MVP Roadmap #30

UlisesGascon opened this issue Dec 5, 2024 · 3 comments
Assignees

Comments

@UlisesGascon
Copy link
Member

UlisesGascon commented Dec 5, 2024

Goals

Before starting MVP development, we completed a Proof of Concept (POC) (official presentation, video, source code, slides).

The primary goal of the MVP is to deprecate the old POC and redesign its components based on the feedback collected during and after its presentation.

The MVP will also enable several critical capabilities as we transition toward the product development phase:

  • Enable external collaboration: Provide tools, guides, and a clear way to identify tasks for contributors. Avoid requiring high-level access to GitHub APIs or infrastructure access for contributions.
  • Support complex workflows: Allow repository content analysis, enabling operations beyond the HTTP API capabilities of the POC.
  • Smooth dashboard-website integration: Ensure seamless integration with the website.
  • Adopt a relational database: Move away from the local filesystem database in favor of a relational database with features like migrations and seeding for improved ergonomics.

Backlog

Milestone 1: Adopt a relational database and migrate away from the POC

Transition from a local filesystem database to a relational database with robust features like migrations and seeding.

Achieved

Milestone 2: Enable external collaboration

Provide tooling, guides, and accessible workflows to encourage contributor involvement without requiring high-level access.

Achieved

Milestone 3: Improve website integration

Ensure seamless integration between the dashboard and the OpenJS Security Program Standards website.

Achieved

Milestone 4: Enable artifacts generation

Support the creation of artifacts such as reports, analysis results, and alerts, with mechanisms for notifying stakeholders.

Achieved

  • Include all the artifacts generation to an specific folder (/output/*) and avoid commit then by include a .gitignore rule
  • @UlisesGascon Add an script to send the generated artifacts to a private artifact directory (TBC)
  • @UlisesGascon Migrate the legacy POC scripts/templates to the MVP and ensure that we can at least generate the same markdown samples but using the database this time
  • @inigomarquinez/@UlisesGascon brainstorm and generated web rich resources that can be embedded into the website (public dashboard information) as a POC

Milestone 5: Ensure compatibility with diverse checks

Support various types of checks, including manual tasks, automated workflows, and complex executors like long-running analyses.

Achieved

@UlisesGascon
Copy link
Member Author

At this stage MVP is completed, only waiting for #56

@bjohansebas
Copy link
Contributor

I believe the MVP is now complete.

@UlisesGascon
Copy link
Member Author

Yep, at this stage we can consider it complete... I will prepare a backlog to discuss about the v1 with the feedback collected from the MVP and then close this issue 🥳.

In the meantime we can focus on Tech debt and adding more compliance checks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants