docs: start adding user roles to getting started documentation

Following CNCF guidelines for improved Backstage documentation.

Signed-off-by: Aramis <sennyeyaramis@gmail.com>
This commit is contained in:
Aramis
2024-01-26 10:11:31 -05:00
committed by aramissennyeydd
parent 25adbdde2d
commit a33bd1f7a8
20 changed files with 584 additions and 568 deletions
+14 -2
View File
@@ -69,8 +69,8 @@ module.exports = {
],
],
markdown: {
preprocessor({ fileContent }) {
// Replace all HTML comments with emtpy strings as these are not supported by MDXv2.
preprocessor({ filePath, fileContent }) {
// Replace all HTML comments with empty strings as these are not supported by MDXv2.
return fileContent.replace(/<!--.*?-->/gs, '');
},
format: 'md',
@@ -152,6 +152,18 @@ module.exports = {
from: '/docs/overview/glossary',
to: '/docs/references/glossary',
},
{
from: '/docs/getting-started/create-an-app',
to: '/docs/getting-started/standalone-install'
},
{
from: '/docs/getting-started/configuration',
to: '/docs/getting-started/standalone-install#next-steps'
},
{
from: '/docs/getting-started',
to: '/docs/getting-started/standalone-install'
},
],
},
],
+7 -4
View File
@@ -40,18 +40,21 @@
"overview/logos"
],
"Getting Started": [
"getting-started/index",
"getting-started/configuration",
"getting-started/create-an-app",
"getting-started/standalone-install",
{
"type": "category",
"label": "App configuration",
"label": "Configuring Backstage (Admin)",
"items": [
"getting-started/config/database",
"getting-started/config/authentication",
"getting-started/configure-app-with-plugins",
"getting-started/app-custom-theme",
"getting-started/homepage"
]
},
"getting-started/logging-in",
"getting-started/register-a-component",
"getting-started/create-a-component",
"getting-started/keeping-backstage-updated",
"getting-started/concepts",
"getting-started/contributors",