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

Rewrite the documentation generation standalone XProc #42

Closed
3 tasks
nikitawootten-nist opened this issue Jul 10, 2023 · 3 comments
Closed
3 tasks

Rewrite the documentation generation standalone XProc #42

nikitawootten-nist opened this issue Jul 10, 2023 · 3 comments
Labels
bug Something isn't working enhancement New feature or request
Milestone

Comments

@nikitawootten-nist
Copy link
Contributor

The standalone documentation generation XProc does not currently write outputs correctly. The document should be rewritten to:

  • Re-use (compose) the hugo documentation generation script (which generates fragments without the included CSS or html body pieces)
  • Add an option to override the included CSS with a user-provided stylesheet
  • Name the input/output ports as described in the ADR output of Helper script for all capabilities #41
@nikitawootten-nist nikitawootten-nist added bug Something isn't working enhancement New feature or request labels Jul 10, 2023
@wendellpiez
Copy link
Contributor

Also: there is WIP XProc now in the repo that could be integrated into this work: a core XProc that runs the entire pipeline while exposing ports, plus a 'wrapper' XProc that exposes no output ports, but instead writes outputs to a designated location.

If this can be emended (a) to capture <div> fragments ready for Hugo, and (b) provide any interfacing for CSS overriding, we will have something that meets the goal of this Issue.

@wendellpiez
Copy link
Contributor

wendellpiez commented Jul 10, 2023

@nikitawootten-nist any chance we could see a link to the place(s) in OSCAL where docs-generation scripting is called? (or: what will the call look like?)

Also note: if we add capabilities vis-a-vis CSS or resource writing we should document those as well. Can we add "update the readme" to the AC for this Issue?

Finally - @aj-stein-nist, the scripts in the repo now (which will be a basis for further work in this Issue), also work to create a standalone docs site for a user's metaschema, with a simple bash script calling maven. This could be tested and demonstrated as-is from #3, and not wait for finer points of Hugo integration.

See https://github.com/wendellpiez/metaschema-xslt/blob/issue2-migration-fixup/src/document/readme.md for more on these scripts and pipelines (kept nearby).

@wendellpiez
Copy link
Contributor

@nikitawootten-nist I think this is done? if so FF to close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants