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

Add header and footer guidance #172

Open
stephiescastle opened this issue Mar 8, 2022 · 6 comments
Open

Add header and footer guidance #172

stephiescastle opened this issue Mar 8, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation Epic needs design input question Further information is requested

Comments

@stephiescastle
Copy link
Member

stephiescastle commented Mar 8, 2022

Description

Our documentation does not include any guidance or examples for the header and footer. We should add this to the Explorer-1 storybook, as users have been requesting this guidance, and it's also one of the final pieces to providing a full site template.

Some notes to consider to help determine scope:

  • Do we want to add both internal and external header/footer? Based on user requests, the external header/footer should be prioritized if we don't have time for both.
  • What is our goal with providing the site header and footer? Is it to provide templates for building an external site with its own site navigation? Or is it to provide templates for building an external site that mimics a WWW sub site, such as: https://www.jpl.nasa.gov/go/astronomy-and-physics ? Note that in the sub-site, the header and footer are unchanged. Only the secondary navigation is custom.
  • If the goal is to allow users to create WWW sub-sites, then we will also need to add guidance on secondary navigation and how it interacts with heroes on the page (scope increase)
  • If the goal is to provide a customizable header and footer, note that in the external header:
    • There are no guidelines on where to put a site title since the header was originally designed for a single site: www.jpl.nasa.gov. Do we want to provide an alternative that includes a site title? We will need design guidance if so.
    • There is no "home" button or a way for users to navigate to the homepage. This wasn't an issue for JPL, as the tribrand logo was the "home" button. A simple solution, if design approves, is to add "Home" as the first item in the navigation. We could alternatively link the site title, if it gets added.
  • How does this affect applications that only need the header and footer? Should we provide a separate resource for that?
@stephiescastle stephiescastle added documentation Improvements or additions to documentation question Further information is requested needs design input labels Mar 8, 2022
@stephiescastle
Copy link
Member Author

stephiescastle commented Mar 14, 2022

Results from a quick chat in our team meeting:

  • We need both external and internal header/footer
  • External header and footer designs: External header and footer design mockups #185
    • For the external header, we will probably need to offer a new option, as the header should be different from the public JPL website
    • Footer: should relate to the site that it is on--its content does not need to be the same as the public JPL website (this is in response to the legacy guideline that would require the footer to match the footer from the public JPL website)
  • Setup pattern for documenting internal and external components: Combine Storybooks #9
    • We need clear documentation about how to use these external and internal components. A couple places this documentation could live:
      • All on Storybook
      • JPL's branding site could be the "accompanying documentation website" to Storybook, with more detail being covered there regarding internal and external site guidelines.
      • We may do a hybrid of the two approaches.

@Scotchester
Copy link
Member

We need clear documentation about how to use these external and internal components. A couple places this documentation could live:

  • All on Storybook
  • JPL's branding site could be the "accompanying documentation website" to Storybook, with more detail being covered there regarding internal and external site guidelines.
  • We may do a hybrid of the two approaches.

I would personally prefer not to put policy-type content in Explorer 1's Storybook, and would prefer to keep that to usage guidelines for designers and developers.

@stephiescastle
Copy link
Member Author

I would personally prefer not to put policy-type content in Explorer 1's Storybook, and would prefer to keep that to usage guidelines for designers and developers.

Agreed. I'm thinking policy type documentation would go on the branding site, but I think we may need a clear indicator in Storybook differentiating the components. Perhaps just the organization in the sidebar is enough, or maybe even a visual badge, flagging something that needs special consideration (ex: image).

@gekim84

This comment was marked as duplicate.

@gekim84

This comment was marked as duplicate.

@gekim84

This comment was marked as off-topic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Epic needs design input question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants