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

Docforge v1 - fully reproducible website bundles from a docforge config and manifest file #401

Open
4 tasks
Kostov6 opened this issue Feb 26, 2025 · 0 comments
Assignees
Labels
kind/enhancement Enhancement, improvement, extension priority/3 Priority (lower number equals higher priority)

Comments

@Kostov6
Copy link
Contributor

Kostov6 commented Feb 26, 2025

What would you like to be added:
Code that makes website bundles fully reproducible without dependency on where docforge is being run. This enables local builds to fully reproduce the deployed website bundle

Why is this needed / describe a real-world scenario:

The main improvements we would like to achieve with docforge v1:

  • future website features are added as quickly and easily as possible with high confidence
  • future website features are encoded into the build configuration. This makes them trivially reusable
  • reduce maintenance cost as much as possible by
    • ensure future changes don't introduce unexpected changes to gardener/website
    • unit test important components
    • easily reproduce and debug faulty build configurations

Those improvements will be reached by achieving the following goals:

  • introduce core package having as little dependencies as possible. It will explicitly define the surface area of the core docforge logic through interfaces
  • introduce core/plugin/interface.go that will be implemented by plugins stored in plugins/<name>
  • split current logic into a md,download,persona,hugo,docsy plugins
  • improve documentation

How to categorize this?:

/kind enhancement
/priority 3

@Kostov6 Kostov6 added the kind/enhancement Enhancement, improvement, extension label Feb 26, 2025
@gardener-robot gardener-robot added the priority/3 Priority (lower number equals higher priority) label Feb 26, 2025
@Kostov6 Kostov6 changed the title Docforge v1 Docforge v1 - fully reproducible website bundles from a docforge config and manifest file Feb 28, 2025
@Kostov6 Kostov6 self-assigned this Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Enhancement, improvement, extension priority/3 Priority (lower number equals higher priority)
Projects
None yet
Development

No branches or pull requests

2 participants