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

NIST Pages site re-design #279

Closed
anweiss opened this issue Dec 14, 2018 · 5 comments
Closed

NIST Pages site re-design #279

anweiss opened this issue Dec 14, 2018 · 5 comments
Assignees
Labels
Epic A collection of issues to be worked on over a series of sprints Scope: Website Issues targeted at the OSCAL project website. User Story

Comments

@anweiss
Copy link
Contributor

anweiss commented Dec 14, 2018

User Story:

To support #273, a complete re-design of the documentation site at https://pages.nist.gov/OSCAL should be in order. As such, I propose we take advantage of the U.S. Web Design System, which is developed by GSA, in combination with the well-documented and well-maintained Jekyll static site generator framework to build a completely new landing page for OSCAL. Below are some screenshots for what a re-design might look like. If you'd like to get an idea of what the source code looks like, feel free to check out https://github.com/anweiss/OSCAL/tree/docs-redesign/docs_jekyll_uswds. It is based on GSA's Jekyll template for the USWDS. I won't push up any PRs until I get a bit more feedback on this. There's also a great opportunity for us to design our own custom, hero graphic for the homepage which accurately depicts the challenges OSCAL aims to solve and in a fun, illustrative manner.

screen shot 2018-12-14 at 3 00 50 pm
screen shot 2018-12-14 at 3 00 59 pm
screen shot 2018-12-14 at 3 01 04 pm
screen shot 2018-12-14 at 3 01 14 pm
screen shot 2018-12-14 at 3 01 25 pm
screen shot 2018-12-14 at 3 01 33 pm
screen shot 2018-12-14 at 3 01 38 pm
screen shot 2018-12-14 at 3 01 42 pm
screen shot 2018-12-14 at 3 01 46 pm
screen shot 2018-12-14 at 3 01 52 pm

CC @akarmel @bbattaglini

Goals:

Provide users with a clean, easy-to-consume experience for learning about OSCAL. Leverage the recommended design guidance for government websites provided by GSA.

Dependencies:

Definitely need to fix #148. Also dependent on #274.

Acceptance Criteria

An intuitive website is built for OSCAL.

@brian-ruf
Copy link
Contributor

@david-waltermire-nist wants to ensure the appropriate NIST header/footer is included per the information here:
https://github.com/usnistgov/nist-header-footer

@anweiss
Copy link
Contributor Author

anweiss commented Dec 20, 2018

Updated the prototype to use the NIST header/footer. Screenshots below:

screen shot 2018-12-20 at 4 33 00 pm

screen shot 2018-12-20 at 4 33 12 pm

@anweiss
Copy link
Contributor Author

anweiss commented Dec 21, 2018

@david-waltermire-nist @wendellpiez we need to figure out if NIST pages supports some sort of "staging" endpoint .. e.g. https://pages-staging.nist.gov/OSCAL ... according to the NIST Pages wiki, it is based on 18F's old pages-server project which seems to indicate support for multiple publishing branches. However, it's likely that one would have to get a hold of the individuals that manage the NIST Pages server.

@brian-ruf
Copy link
Contributor

1/31/2019 - @bbattaglini to enter related issues, which will then be linked to this issue. Then we will close this issue.

@david-waltermire
Copy link
Contributor

The work has been done on this. We are reviewing the site in #311. The current site content is in PR #326. I am going to close this issue.

@david-waltermire david-waltermire added this to the OSCAL 1.0 M1 milestone May 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic A collection of issues to be worked on over a series of sprints Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
None yet
Development

No branches or pull requests

5 participants