usnistgov / oscal-tools

Tools for the OSCAL project
https://pages.nist.gov/oscal-tools/
34 stars 17 forks source link

Update README and Archive Project #77

Closed aj-stein-nist closed 1 year ago

aj-stein-nist commented 1 year ago

Image

Dependencies:

aj-stein-nist commented 1 year ago

@wendellpiez as discussed today when pairing on related issues, can you please work on this during the sprint with the intent to resolve it by 15 March 2023? If you have concerns about finishing it by then, or think you need help to do so to finish it by then, please let me know. It will be superful help, thanks!

wendellpiez commented 1 year ago

Started on this by copying all the WIP sitting in my fork out to a branch of the oscal-xslt repo to be merged there.

Next steps here (in a branch):

(I am not sure you are currently using this checklist, but please make sure to complete all identified work expressly mentioned in issue description, we will discuss during the next status update.)

nikitawootten-nist commented 1 year ago

Update: the team plans to draft a unified archiving message before making individual PRs.

aj-stein-nist commented 1 year ago

@wendellpiez I updated the checklist for completion of this task to address some questions and ambiguities around the work it is in the updated issue description above. I hope this clarifies what needs to be done. Please let me know if you cannot complete by COB tomorrow (end of sprint).

wendellpiez commented 1 year ago

@aj-stein-nist I can work on this but it's going to be a close one.

Main reason being that adding a banner in Hugo with language and styling has to be done through templating. Is anyone else having to set this up in Hugo?

aj-stein-nist commented 1 year ago

@aj-stein-nist I can work on this but it's going to be a close one.

Main reason being that adding a banner in Hugo with language and styling has to be done through templating. Is anyone else having to set this up in Hugo?

We can work together on this but it seems beyond the USA banner there is a DRAFT equivalent we can work off of:

https://github.com/usnistgov/hugo-uswds/blob/2d6444fcb9f788e275dcc56cbee2ef7002045e2c/layouts/partials/components/draft-banner.html

https://github.com/usnistgov/hugo-uswds/blob/2d6444fcb9f788e275dcc56cbee2ef7002045e2c/layouts/_default/index.html#L7

Similar idea, different content, is this a good starting point? It is like usabanner: true you use and draftbanner: true could work we just need to make an archivebanner and set that to true. I guess that would require either: setting up in hugo-uswds or overriding the default template here. I guess that changes the timeline.

wendellpiez commented 1 year ago

I actually designed and deployed a 'draft' banner -- problem there being it requires a flag on each page as you say.

Instead I am hacking a usa-banner into the banner.html template, which seems to work so far.

image

wendellpiez commented 1 year ago

image

I changed the language slightly to say a tiny bit less.