Comments (6)
Hey Chris, there is actually a simpler way to work around this. Makefile variables can be overridden, so instead of editing list_revisions.sh
you can just override the variable its result is stored in:
$ make site REVISIONS="v1.1.0 my-test-branch my-other-test-branch"
This behavior is a bit unexpected. I agree it should be documented somewhere.
from oscal-reference.
Thanks. I need to make another feature branch this afternoon and start work, so I'll reset and try this out.
from oscal-reference.
As for pointing at alternative OSCAL source repositories, currently you would have to edit the generate_modeldoc.sh
script, but the script could be edited to either:
- Accept an environment variable to override the OSCAL source directory
- Expect the OSCAL source directory to be passed in as an argument, so that it would also be controlled via the Makefile
The ladder has some interesting properties, such as allowing the Makefile to ensure the user has initialized the submodule (unless it has been overridden).
from oscal-reference.
This approach seems to be working for me. I've adjusted the generate_modeldoc script and Makefile to support the local OSCAL repo part, and I'll push it up as a feature branch sometime today for consideration. I need to add something to the readme on how to use.
from oscal-reference.
This approach seems to be working for me. I've adjusted the generate_modeldoc script and Makefile to support the local OSCAL repo part, and I'll push it up as a feature branch sometime today for consideration. I need to add something to the readme on how to use.
Awesome, if possible I'd like to also amend the script to optionally not use a worktree (just use the provided oscal folder without making a temporary copy)
from oscal-reference.
The solution indicated by @nikitawootten-nist needs to be tested and documented in the README with examples of how to:
- override the REVISION to generate the documentation for a single branch or a selected list of branches (releases or prototypes) 2.
- pointing at alternative OSCAL source repositories by editing the generate_modeldoc.sh script.
Alternatively, the script can be modified under this issue, to accept an environment variable to override the OSCAL source directory
OR to expect the OSCAL source directory to be passed in as an argument, so that it would also be controlled via the Makefile
from oscal-reference.
Related Issues (15)
- Overlapping elements in outline pages of generated model reference HOT 3
- Replace OSCAL data type pages with links to Metaschema datatypes HOT 4
- Include OSCAL processing specifications HOT 1
- Options needed for publishing draft/experiment work as a part of DEFINE HOT 4
- Set up meta redirects linking users to release artifacts
- Add notice of experimental prerelease models HOT 1
- [Dummy Issue] Testing Issue Triage
- Release assets redirect missing from generated pages site
- Last update date in footer of model-specific documentation is not set. HOT 3
- Correct schema and model links
- Set up linkchecking HOT 3
- Incorrect Allowed `@name` values for `@prop` in documentation HOT 11
- OSCAL-Reference needs a nice landing page. HOT 7
- Model reference pages failing to link between each other HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from oscal-reference.