Home

User research

• Summary
• Ethics and Privacy in User Research
• OIRA User Research Training

Site documentation

General content editing tasks

• Add or remove a subpage
• Adding an inline link
• Uploading a PDF
• Creating anchor links
• Front matter options
• Directory structure

Content specific tasks

• Add an agency contact
• Add a glossary term
• Updating sitewide settings
• Adding a link to the site feedback email address

Launch specific information

Upon launch of the website:

• Delete the /robots.txt file to allow search engines to index content
• Update the github.default_branch value in _config.yml to point to master
• If needed, a sitemap.xml is automatically generated and is available at /sitemap.xml

Design

• Design principles
• Color
• Typography
• Logo and social media assets

Accessibility

• Accessible choices
• Release checklist

Further reading

GitHub

• Slide deck from in-person training

Federalist: static site generator

• Documentation
• Instructional demos
• Making Government Websites with GitHub, Federalist & U.S. Web Design System

Markdown: plain text formatting language

• Basic writing and formatting, GitHub Help
• Mastering Markdown, GitHub Guides