Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 4.51 KB

README.md

File metadata and controls

83 lines (56 loc) · 4.51 KB
Raw

Site Nav Test Drive

This tool will not work with sites that have Cross-Origin Resource Sharing (CORS) restrictions, which prevents some sites from appearing in an iframe element on another site.

Why you need it

  • Try out new navigation with usability tests in realtime on a working site.
  • Validate card sorts and tree jacks with qualitative research.
  • Work out thorny information architecture issues before your team starts coding.

How it works

  1. Define your new navigation labels with links to the current site.
  2. Enter the address of your current site.
  3. Set the amount of overlap you need to hide the current navigation.

You now have a working navigation component layered on top of the current site that testers can use to experience the current content in a new way!

How to…

Speak GitHub

GitHub uses some different language to describe things and actions you're probably already familiar with. See this handy GitHub Glossary if you're not sure about some of the terms used in these instructions.

Make your own copy of the repository

  1. If you don't have one, create a GitHub account.
  2. On the Code tab of the repository homepage, press the Use this template button.
  3. Finish creating your copy of the repository.

Go live using GitHub Pages

GitHub Pages will compile and host your site automatically. Enable this feature first so you can see your changes in the browser without having to run the site locally.

Note: It takes a few seconds to a minutes to go live, so the first time you go to the site, you may see a "404: Page Not Found" error. After it's live, you should see any changes you make to the main branch at the Pages URL, usually within a few seconds.

  1. Go to the Settings tab.
  2. Go to Pages in the side navigation.
  3. In the Source section, set the branch to main and press Save.

Tip: Copy the Pages URL and add it to your repository About section for easy access. The About section is on in the sidebar of the repository homepage. To edit it, click the gear icon. You can also see the log of publishing activity by pressing the Environments link in the sidebar on the repository homepage.

Configure settings

You'll need to change a few settings in the config file for your site to work properly.

Project site settings

  1. Go to the _config.yml in your repository.
  2. Press the Edit this file button (pencil icon).
  3. Make changes to following settings:
    • title: The title of the site that shows up in the browser tab and on the homepage.
    • description: The description that shows up on the homepage and also the meta description for search engine optimization.
    • baseurl: This needs to match the name of your repository for internal links to work.
  4. Save your changes by pressing the Commit changes button.

Test site settings

  1. Go to the _config.yml file in your repository.
  2. Press the Edit this file button (pencil icon).
  3. Make changes to following settings:
    • test-site: The URL of the site you want to test. (If the site doesn't appear, it may be restricted from working with site-nav-test-drive.)
    • test-site-name: The name of the site you want to appear in the header section.
    • nav-offset: The amount of offsite needed to cover the test site nav with the new nav.
    • brand-color: The primary brand color to match the new nav with the test site.
  4. Save your changes by pressing the Commit changes button.

Edit navigation content

  1. Go to the index.md file in your repository.
  2. Press the Edit this file button (pencil icon).
  3. Change the nav titles and subnav titles and urls as needed.
    • Be sure to maintain the existing indents and spacing.
    • Use full URLs (starting with "https") and keep them in quotes.
  4. Save your changes by pressing the Commit changes button.

Team

This project was built by the Rapid Response Team at Bixal: Philip Levy, Brianna Naolu, and Kayla Chumley.

Credit and license

This project was created using the GitHub Pages gem for Jekyll and a hosted version of the U.S. Web Design System on CDNJS.

This project is licensed under The Unlicense, which allows everything and promises nothing. 🌊