-
Notifications
You must be signed in to change notification settings - Fork 66
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
Update documents to use latest NIST Metanorma toolchain #1318
base: master
Are you sure you want to change the base?
Conversation
@livebe01 the current PR is failing due to the missing access token here: https://github.com/usnistgov/ACVP/pull/1318/files#diff-3414847e2ad632333f775cabb810f0dc0df61a570365df34750a08b00912fe82R15 Without this token the build will not work. |
Hi @ronaldtse, we just wanted to touch base with you regarding this PR; this is still within our radar and on our docket, appreciated! |
Thanks @jbrock24 for the update! This PR probably needs a bit of update, we'll do that and ping you again. |
No problem. We'll let you know, thanks again! |
Thanks @ronaldtse, we'll get it pushed through this time. |
Great, thank you! |
NOTE: Background and additional information provided in metanorma/metanorma-nist#300.
Info: List of changes
Clean up bibliographic entries
When multiple documents refer to the same hard-coded bibliographic entries, we can share the same entry.
Addendums (the only entry is SP 800-38A-Add) are now supported in reference auto-fetch:
Drafts are now supported in reference auto-fetch:
Some clean up of AsciiBib anchors:
Migrate ACVP documents to NIST CSRC format
The full conversion to the official Metanorma NIST format:
There are differences from the previous workflow:
Clean up GitHub Pages deployment of ACVP
I have also cleaned up the deployment of
index.html
so that GitHub Pages now automatically generates the HTML and CSS automatically.This implementation now keeps the NIST headers/customizations without needing to keep
index.html
as part of the repository.Notice the NIST headers/footers don't work right now. This is because of CORS -- the NIST headers/footers script only works on https://pages.nist.gov, and when loaded on other domains (except 127.0.0.1) they will fail to execute. i.e. when this is deployed at the correct location, the headers/footers will work.
WARNING: After merging this PR
After merging the PR, you need to do two things.
Update Jekyll's
_config.yml
Because of how ACVP is deployed to a custom domain name at
https://pages.nist.gov
, additional configuration may be needed at GitHub Pages after merging the PR.You may need to add this config to your
_config.yml
file in the ACVP repository, which is used for GitHub Pages / Jekyll to generate the site (the code is currently commented out at https://github.com/metanorma/ACVP/blob/d6341de436137253cdcb201e40d17502a4edf116/_config.yml#L5-L8):Enter a Personal Access Token into the "Secrets" section that has access to Metanorma NIST
Metanorma NIST is only available to and accessible by NIST staff.
A GitHub Personal Access Token (PAT) is used to validate access. An account that the PAT is generated from must already have access to the
metanorma-nist
gem and themetanorma-nist
docker container.NOTE: Please contact the CSRC publications team if additional access is required.
In the GitHub Actions workflow, there are two locations where the private token is used:
You will need to set this token on the "Settings > Secrets" page at usnistgov/ACVP, see this guide for details.