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.

Sign up for GitHub

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

Jump to bottom

Profile resolution how-to readmes #1178

Closed
wendellpiez opened this issue Mar 15, 2022 · 8 comments · Fixed by #1175 or #1666
Closed

Profile resolution how-to readmes #1178

wendellpiez opened this issue Mar 15, 2022 · 8 comments · Fixed by #1175 or #1666
Assignees
@nikitawootten-nist
Labels
bug Profile Resolution Issues relating to profile resolution.
Milestone
v1.1.0

Comments

@wendellpiez
Copy link
Contributor

Describe the bug

Examining improvements to profile resolution code (#1175) we are finding the readmes directing users in operating the profile resolver are defective.

The readmes explaining how to operate the XSLT profile resolver, with dependencies, limitations, and options, need to be updated.

Who is the bug affecting?

Anyone who wants to use the profile resolver and can't figure it out for themselves.

What is affected by this bug?

XSLT profile resolver is harder to (figure out how to) use.

Expected behavior (i.e. solution)

Update the readmes to be more helpful.
@wendellpiez wendellpiez added bug Profile Resolution Issues relating to profile resolution. labels Mar 15, 2022
@aj-stein-nist aj-stein-nist added this to the OSCAL 1.0.3 milestone Mar 15, 2022
@wendellpiez wendellpiez mentioned this issue Mar 15, 2022
Merged
8 tasks
@galtm
Copy link
Contributor

galtm commented Apr 5, 2022

Addressed in 0d0c508 as part of #1175

@david-waltermire
Copy link
Contributor

This was a follow-on to an OSCAL 1.1.0 task, which was marked as 1.0.3. Moved this to the 1.1.0 milestone.

@david-waltermire david-waltermire linked a pull request Apr 15, 2022 that will close this issue
Profile resolver: Metadata tests and way of determining top UUID #1175
Merged
8 tasks
@nikitawootten-nist
Copy link
Contributor

I'll take this one over. As someone who has no idea how the XSLT profile resolution workflow works, I can probably understand the audience.

@galtm
Copy link
Contributor

galtm commented Feb 16, 2023

@nikitawootten-nist , I'm not sure what branch you plan to work on, but I just wanted to mention that the develop branch has some updates that aren't on the main branch.

@nikitawootten-nist
Copy link
Contributor

nikitawootten-nist commented Feb 22, 2023 •
edited
Loading

I'll be working out of the develop branch, thanks.

@galtm Unless #1639 merges before I am done, I'll also add a note specifying that Saxon 11 and 12 are not currently supported to the readme.

@nikitawootten-nist nikitawootten-nist mentioned this issue Feb 22, 2023
Merged
7 tasks
@nikitawootten-nist nikitawootten-nist moved this from Todo to Under Review in NIST OSCAL Work Board Feb 22, 2023
@nikitawootten-nist
Copy link
Contributor

Also contingent on #1639, I added a nice helper script that should assist users living in https://github.com/nikitawootten-nist/OSCAL/blob/nikitawootten-nist/issue1178_wrapper-script/src/utils/util/resolver-pipeline/oscal-profile-resolve.sh

@aj-stein-nist aj-stein-nist linked a pull request Feb 27, 2023 that will close this issue
Profile resolution how-to readmes #1666
Merged
7 tasks
@aj-stein-nist
Copy link
Contributor

Also contingent on #1639, I added a nice helper script that should assist users living in https://github.com/nikitawootten-nist/OSCAL/blob/nikitawootten-nist/issue1178_wrapper-script/src/utils/util/resolver-pipeline/oscal-profile-resolve.sh

I am working down the review and merge of that PR to see if we can get this all in, thanks for the reminder last week.

aj-stein-nist added a commit that referenced this issue Mar 3, 2023
@nikitawootten-nist @aj-stein-nist
Profile resolution how-to readmes (#1666)
088dcd6 
* Profile resolution how-to readmes
Fixes #1178

* Delete old `resolver-2018` folder

* Update resolver-pipeline readme.md with more generic instructions on running the pipeline

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Remove notice to only use Saxon 10 in line with previous feedback

* Added instructions for the wrapper script

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
@aj-stein-nist
Copy link
Contributor

Relevant code was merged early so this could get pulled in as completed.

@aj-stein-nist aj-stein-nist moved this from Under Review to Done in NIST OSCAL Work Board Mar 3, 2023
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 29, 2023
@nikitawootten-nist @aj-stein-nist
Profile resolution how-to readmes (usnistgov#1666)
500fbdd 
* Profile resolution how-to readmes
Fixes usnistgov#1178

* Delete old `resolver-2018` folder

* Update resolver-pipeline readme.md with more generic instructions on running the pipeline

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Remove notice to only use Saxon 10 in line with previous feedback

* Added instructions for the wrapper script

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jul 10, 2023
@nikitawootten-nist @aj-stein-nist
Profile resolution how-to readmes (usnistgov#1666)
d54cf49 
* Profile resolution how-to readmes
Fixes usnistgov#1178

* Delete old `resolver-2018` folder

* Update resolver-pipeline readme.md with more generic instructions on running the pipeline

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Remove notice to only use Saxon 10 in line with previous feedback

* Added instructions for the wrapper script

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
aj-stein-nist added a commit to galtm/OSCAL that referenced this issue Sep 28, 2023
@nikitawootten-nist @aj-stein-nist
Profile resolution how-to readmes (usnistgov#1666)
f429e33 
* Profile resolution how-to readmes
Fixes usnistgov#1178

* Delete old `resolver-2018` folder

* Update resolver-pipeline readme.md with more generic instructions on running the pipeline

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Remove notice to only use Saxon 10 in line with previous feedback

* Added instructions for the wrapper script

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
aj-stein-nist added a commit that referenced this issue Sep 28, 2023
@nikitawootten-nist @aj-stein-nist
Profile resolution how-to readmes (#1666)
66ed25b 
* Profile resolution how-to readmes
Fixes #1178

* Delete old `resolver-2018` folder

* Update resolver-pipeline readme.md with more generic instructions on running the pipeline

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Remove notice to only use Saxon 10 in line with previous feedback

* Added instructions for the wrapper script

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nikitawootten-nist nikitawootten-nist

Labels
bug Profile Resolution Issues relating to profile resolution.
Projects
NIST OSCAL Work Board
Status: Done
Milestone
v1.1.0
5 participants
@wendellpiez @david-waltermire @galtm @nikitawootten-nist @aj-stein-nist