Pantheon Community

Meet the Docs Glossary

Today I want to introduce you to our Documentation Glossary. Like the name suggests, this is a collection of terms, with their definitions, that are used in Pantheon’s documentation.

How are terms added to the Glossary? So glad you asked!

Terms are added to the Glossary automatically when the DFN tag or Definition list are used.

If you are looking for ways to contribute to Pantheon’s Documentation project (for the Gift of Open Source event, perhaps), the Glossary is a great place to start. All of these terms are defined within the context of their topic of origin but many can and should be updated to more strongly stand alone.

Check out the definition of bias, for example. the definition assumes the reader knows its talking about a Solr index, but that might not be true. If you want to try your hand at updating the Glossary, PRs are welcome!

3 Likes