paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

Backstage Glossary Documentation (#4073)

Browse Source 
* add Backstage Glossary documentation

* Update docs/glossary.md

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>

* Update docs/glossary.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* Update docs/glossary.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>

* updates from feedback

Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
This commit is contained in:
Emma Indal
2021-01-15 10:45:39 +01:00
committed by GitHub
parent 2b7ba47ce2
commit 057cb8e84f
3 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/glossary.md
+21
View File
@@ -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. |
microsite/sidebars.json
+1
View File
@@ -176,6 +176,7 @@
],
"Contribute": ["../CONTRIBUTING"],
"Support": ["support/support", "support/project-structure"],
"Glossary": ["glossary"],
"FAQ": ["FAQ"]
}
}
mkdocs.yml
+1
View File
@@ -117,4 +117,5 @@ nav:
- Support:
- 'support/support.md'
- 'support/project-structure.md'
- Glossary: glossary.md
- FAQ: FAQ.md