Skip to content

Tagging on the Blog

Andrew Burnes edited this page Oct 24, 2019 · 21 revisions

Some guidelines for tagging on the blog.

Formatting

  • use all lower case tag names, even for proper nouns and acronyms (i.e. "18F" should be "18f", "GSA" should be "gsa"). We format them when we generate the site.

  • separate words with spaces not dashes or underscores (correct example: "the hub", incorrect examples: "the-hub" or "the_hub")

  • numbers are allowed

  • list them like this:

    tags:
    - 18f
    - how we work
    - tagging
    

Why is this important?

If you generate the site locally and look in the _site/tags/ folder you might notice a few folders that look like they break these rules. There are a few reasons for that.

When Jekyll generates the site it makes a folder and an index.html file inside it for each tag. When it does that it automatically substitutes all spaces with -. This is why it's important to always use spaces and not dashes. When Jekyll sees, for example, how we work on one post, it generates the how-we-work folder in your _site/tags directory. Then, if it sees how-we-work on a different post it overwrites the how-we-work folder it already created and you end up with an incomplete archive of only the posts tagged how-we-work. The same is true for capitalization.

All this means we need to be consistent and the formatting rules above are how we've decided to stay consistent.

Redirections

When we first got this site started we used the same rules but didn't rely on Jekyll's way of generating tag archives. We did it on our own and https://18f.gsa.gov/tags/how%20we%20work was the archive for the how we work tag. The catch was that https://18f.gsa.gov/tags/how-we-work was also a page that was an archive for anything we didn't tag correctly. Other examples are tags/18F events and tags/18F Consulting which had counterparts at: tags/18f events and tags/18f consulting.

When we fixed that problem we also set up redirects for the older URLs to go to the right place. That's why you see both how we work and how-we-work folders in the _site directory. One (how we work) is the redirect pointing to the other (how-we-work). We do this to make sure people with bookmarks, other sites, and search engines all get to the right place. To see how we do it, check out this pull request which added the redirects and the jekyll-redirect-from plugin we use to make it happen.

With that in mind, please, use the list below and the formatting rules above as your guide for tagging posts, not the contents of your _site/tags folder.

Adding a new tag

When adding a new tag in a blog post's tags key, you may need to add the new tag to the tests in the /tests/schema/tags.yml list. Note, this only applies to tags that have not already been added to the tag list.

Which tags to use?

Try to use one of the tags below (last updated August 2019). The most current version of this list lives here.

  • 10x
  • 18f
  • 18f.gsa.gov
  • accessibility
  • acquisition services
  • agency work
  • agile
  • agile bpa
  • alaska
  • analytics.usa.gov
  • anniversary
  • api
  • ask 18f
  • best practices
  • c2
  • calc
  • cloud.gov
  • code.gov
  • collaboration tools
  • college scorecard
  • communicart
  • communication tools and practices
  • content design
  • convincing stakeholders
  • culture
  • culture change
  • data access
  • data act
  • day in the life
  • demo day
  • department of commerce
  • department of justice
  • department of labor
  • design
  • devops
  • digital acquisition accelerator
  • digital services movement
  • digitalgov community
  • discovery.gsa.gov
  • distributed
  • education
  • encasement
  • environmental protection agency
  • eregulations
  • evangelism
  • events
  • every kid in a park
  • fbi
  • fbopen
  • fec.gov
  • federal front door
  • federalist
  • foia
  • forest service
  • general services administration
  • gov.uk
  • guides
  • gsa
  • hackathons
  • health and human services
  • hiring
  • how we work
  • https
  • hub
  • identity
  • interview
  • it centralization
  • jekyll
  • join us
  • legacy
  • lessons learned
  • login.gov
  • machine learning
  • micro-purchase platforms
  • midas
  • military
  • modern practices
  • modular contracting
  • myusa
  • nasa
  • navy reserve
  • national science foundation
  • national technical information service
  • navy reserve
  • new ten
  • onboarding
  • open data
  • open government
  • open opportunities
  • open source
  • peace corps
  • platforms
  • presidential innovation fellows
  • product
  • product launch
  • procurement
  • public buildings service
  • pulse.cio.gov
  • rfp ghostwriting
  • second anniversary
  • security
  • speaker series
  • staff profiles
  • state and local practice
  • talent
  • technical debt
  • technical guides
  • technology transformation services
  • testing
  • tools you can use
  • training
  • transformation services
  • transparency
  • treasury
  • u.s. digital service
  • u.s. geological survey
  • usability
  • uscis
  • useiti
  • user research
  • user-centered design
  • video
  • vote.usa.gov
  • web design system
  • workshop