diff --git a/docs/glossary.md b/docs/glossary.md new file mode 100644 index 0000000000..dc67b2aae2 --- /dev/null +++ b/docs/glossary.md @@ -0,0 +1,21 @@ +--- +id: Glossary +title: Backstage Glossary +# prettier-ignore +description: List of all the terms, abbreviations, and phrases used in Backstage, together with their explanations. +--- + +The Backstage Glossary lists all the terms, abbreviations, and phrases used in +Backstage, together with their explanations. We encourage you to use the +terminology below for clarity and consistency when discussing Backstage. + +### Backstage User Profiles + +There are three main user profiles for Backstage: the integrator, the +contributor, and the software engineer. + +| Term | Explanation | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Integrator | The **integrator** hosts the Backstage app and configures which plugins are available to use in the app. | +| Contributor | The **contributor** adds functionality to the app by writing plugins. | +| Software Engineer | The **software engineer** uses the app's functionality and interacts with its plugins. In practice, this profile covers the various roles that help deliver software, from the Software Engineer themselves, to Designers, Data Scientists, Product Owners, Engineering Managers, etc. | diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 3d6417cc65..07245e75e5 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -176,6 +176,7 @@ ], "Contribute": ["../CONTRIBUTING"], "Support": ["support/support", "support/project-structure"], + "Glossary": ["glossary"], "FAQ": ["FAQ"] } } diff --git a/mkdocs.yml b/mkdocs.yml index 29198963e3..fce5fc1a42 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -117,4 +117,5 @@ nav: - Support: - 'support/support.md' - 'support/project-structure.md' + - Glossary: glossary.md - FAQ: FAQ.md