Main goal: I want to be able to add whatrecord to an IOC CI pipeline and generate a static webpage that serves something similar to the current frontend. Of course, the generated pages would be limited to whichever IOCs that have been analyzed in that pipeline.
Current Behavior
whatrecord requires a backend server (aiohttp-based) and a frontend server (vite/vue.js-based) to be running.
I thought this was the best way to use the information that whatrecord could scrape ("parse all the IOCs and make a big database of records that could be easily queried!"), however this has proven to not be something people really want.
Possible Solution
Make a tool for the server to dump its state to a JSON file (perhaps gzipped, since browsers can easily support that)
Adjust the whatrecord frontend to support that offline store - referring to that JSONified server state rather than the API server
Add a sample CI pipeline to publish the result to GH pages
Context
This will be nice for having whatrecord in CI pipelines for startup script linting and then documentation page generation.
Once we move all of our IOCs to GitHub, some form of auto-generated documentation will be desirable. I'm not aware of any alternative tools, so this concept is first in the list of options.
Expected Behavior
Main goal: I want to be able to add whatrecord to an IOC CI pipeline and generate a static webpage that serves something similar to the current frontend. Of course, the generated pages would be limited to whichever IOCs that have been analyzed in that pipeline.
Current Behavior
whatrecord requires a backend server (aiohttp-based) and a frontend server (vite/vue.js-based) to be running.
I thought this was the best way to use the information that whatrecord could scrape ("parse all the IOCs and make a big database of records that could be easily queried!"), however this has proven to not be something people really want.
Possible Solution
Context
This will be nice for having whatrecord in CI pipelines for startup script linting and then documentation page generation.
Once we move all of our IOCs to GitHub, some form of auto-generated documentation will be desirable. I'm not aware of any alternative tools, so this concept is first in the list of options.
Aiming for ICALEPCS '23 for this functionality.