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

new XProc for docs generation; cleanup and renaming #46

Merged
merged 9 commits into from
Aug 10, 2023

Conversation

wendellpiez
Copy link
Contributor

Committer Notes

Includes new XProcs and scripts for running them.

Revisions to the core docs XProc expose more (intermediate) ports. Also, we have new or modified XProc and scripts for:

  • generating a Hugo-read set of pages and exposing on ports
  • writing the same set of pages to a path
  • producing a standalone site with complete HTML+CSS

The PR addresses #42, with the exception of the requirement for total CSS configurability.

The capability to create and skin a standalone site is provided.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website and readme documentation affected by the changes you made? Changes to the website can be made in the website/content directory of your branch.

@wendellpiez wendellpiez marked this pull request as ready for review July 25, 2023 17:47
@wendellpiez wendellpiez requested a review from a team as a code owner July 25, 2023 17:47
@wendellpiez
Copy link
Contributor Author

This branch includes a number of improvements to the docs generation pipeline, for maintainability.

Although interfaces (especially names and arguments of scripts) should not have changed, due diligence is always warranted.

@wendellpiez wendellpiez force-pushed the issue42-docs-gen-scripting branch from 75350bf to 9a3a746 Compare July 27, 2023 20:11

### `METASCHEMA-DOCS-TRACE.xpl`
For ease of configurability, this pipeline works like `METASCHEMA-DOCS-TESTSITE-write.xpl` except Given a `path` to write to and a key name (schema name), this pipeline serializes and writes a set of documentation rooted at HTML `div` elements, suitable for ingestion into Hugo or any other HTML-based publishing system.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something doesn't look right.

  1. "except Given" looks like the first sentence is missing its ending.
  2. Is the sentence starting with "Given" supposed to be here?
  3. Is the first sentence supposed to compare this pipeline to METASCHEMA-DOCS-DIVS-write.xpl (the one above) or METASCHEMA-DOCS-TESTSITE-write.xpl (the one below, which refers back to this one)?

Copy link
Contributor

@david-waltermire david-waltermire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provided some non-blocking comments.

Copy link
Contributor

@nikitawootten-nist nikitawootten-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, could you:

  1. Add the scripts to the metaschema-xslt command
  2. Adjust the help output to use the BASE_COMMAND environment variable (look at the existing scripts in the metaschema-xslt command for reference
  3. Push up existing changes related to previous reviewer's comments

@wendellpiez wendellpiez merged commit 68a21bc into usnistgov:develop Aug 10, 2023
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

Successfully merging this pull request may close these issues.

4 participants