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

Remove / Refactor Documentation Generation #25

Open
nicholac opened this issue Mar 29, 2023 · 0 comments
Open

Remove / Refactor Documentation Generation #25

nicholac opened this issue Mar 29, 2023 · 0 comments
Labels
feature New feature or functionality

Comments

@nicholac
Copy link
Contributor

Data Processors generate their own documentation (index & license files). Example here.

Boundary Processor sets up the file-structure and also includes boiler-plate introduction html files for the project. Example here.

The original design involved serving these files to enable browsing of the package trees independently (i.e. outside global.infrastructureresilience.org site).

image

Given we now have improved metadata in the Processor Metadata classes and the frontend is serving this; are the flat html files still required?

Options:

  • Remove HTML generation completely from all Processors (boundary must still generate the folder structure ofc)
  • Refactor HTML generation to use templating and new metadata.
  • Others?
@tomalrussell tomalrussell added the feature New feature or functionality label Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or functionality
Projects
None yet
Development

No branches or pull requests

2 participants