Glossary Template

Glossary Markdown Template

The Magento Glossary uses a markdown template for term definitions and frontmatter that controls the display, tags, and specifics for the term.

Frontmatter	Description	Required?
title:	The glossary term.	Yes
word-class	Type for the term: adjective, noun, verb. One or more.	Yes
tags:	Taxonomy through grouping by tag. Use tags provided in the Tags Reference to ensure all terms correctly group together.	Yes
synonyms:	List of synonyms (comma delimited) to aid with searches (Algolia). This does not display in the output.	No
related-terms:	The markdown file name for another term in this glossary. For example 'magento-adminadds a link tomagento-admin.md` to this term. A term .md file must be in the repo to link.	No

Template:

---
title: "Term Name"
word-class:
  - "noun"
  - "verb"
  - "adjective"
tags:
  - "tag-name"
synonyms:
  - "Another Word"
related-terms:
  - "name-of-term-file"
---
Definition.

Learn more: [Page](link)

Example for Magento Admin:

---
  title: "Magento Admin"
  wordClasses: 
    - "noun"
  tags: 
    - "magento-software"
  synonyms: 
    - "Admin"
    - "Admin Panel"
    - "backend"
    - "Administration Interface"
    - "Admin UI"
  relatedTerms: 
    - "admin"
---
The password-protected back office of your store where orders, catalog, content, 
and configurations are managed. Users access the Magento Admin to manage the store, 
including products, orders, shipments, CMS content, design of the storefront, 
customer information, etc. Magento users have an associated role with permissions 
that controls access to features, options, and capabilities.

Learn more: [Magento User Guide](https://docs.magento.com/m2/ce/user_guide/getting-started.html)

Tag Reference

To ensure all terms correctly group together without variations of a tag spelling, etc, we have a curated list of tags to use. All tags are saved to tag-list.json (we use slug for tags). Please request tag additions before editing or adding to this file.

❗ Every term should have at least 1 tag. Terms can support multiple tags.

Example:

  tags: 
    - "magento-software"

  tags: 
    - "magento-software"
    - "product"

List of tags:

• business
• cloud
• customer
• design
• inventory
• magento-software
• marketing
• order
• pricing
• product
• programming