Home

UX Content Glossary Collaboration Documentation

This wiki aims to describe everything you need to know about the glossary project. (A-hem! Usable wiki docs can be a challenge to construct, especially when navigation features are limited, as they are here. If you have a gripe or suggestion about docs or collaborative processes described, start a new Issue to share your thoughts. We welcome it.)

Project overview

Get the big picture perspective of the glossary project:

• Audience and scope
• Project phases (from now to post-production)
• Project collaboration (how we work together)

Development status

The mile-high picture of where we're at. When all boxes are checked in the following 2 lists, we've reached cruising speed.

Glossary content:

• Issues created for initial terms:
  • Dropped terms
  • Primary terms (about 80% done)
• Source files started for initial primary terms (1%)
• Initial term definitions production ready ( <1%)

Development:

• Collaborative protocols established (using issues and using issue labels)
• Glossary architecture conceived (production glossary structure)
• Wiki docs written
• Production site set up with Google Page & Jekyll (Glossary Index
• Definition template created (can be used now)
  • Accessibility attributes added to template
  • Semantic schema (RDFa) attributes added to template
• Glossary index templates fully constructed
• Custom subdomain set up (glossary.csf.community )

If we go forward with the subdomain, it probably won't be "https", because you can't set it up on a GitHub Page without using Cloudflare, and we're not setting up a Cloudflare account for that one purpose. Since this site is a static file system with no data transactions, it's not a big deal anyway.

Sign up and set up

You can't do anything until you do this first, in order:

1. Create a free GitHub account, if you don't have one.
2. Request to collaborate.
3. Find a good text editor
4. Install the GitHub desktop client
5. Clone the master repository
   • Psst! A cool "clone setup" diagram
6. Tour the GitHub client UI

Collaborate

• Routine contributions (workflow scenarios)
• Collaborative decision-making
• Using issues (decision histories)
• Using issue labels (status flags)
• Communication channels (merge into decision-making?)

Collaborator resources

For the words people:

• Style guidelines
• Glossary Markdown cheatsheet
• Definition template

For the code and colors people:

• Production glossary structure
  • Psst! A sweet "collaboration to production" diagram
• Definition template

GitHub explained

Explorers will explore.

• GitHub overview (basic, in context of this project)
• GitHub client UI explained
• Clone the master repository
• GitHub client push commits
• Troubleshooting repository conflicts