Merge pull request #22541 from sennyeya/documentation/getting-started

docs: start adding user roles to getting started documentation
This commit is contained in:
Ben Lambert
2024-03-05 13:24:03 +01:00
committed by GitHub
20 changed files with 548 additions and 516 deletions
+9 -1
View File
@@ -70,7 +70,7 @@ module.exports = {
],
markdown: {
preprocessor({ fileContent }) {
// Replace all HTML comments with emtpy strings as these are not supported by MDXv2.
// Replace all HTML comments with empty strings as these are not supported by MDXv2.
return fileContent.replace(/<!--.*?-->/gs, '');
},
format: 'md',
@@ -152,6 +152,14 @@ module.exports = {
from: '/docs/overview/glossary',
to: '/docs/references/glossary',
},
{
from: '/docs/getting-started/create-an-app',
to: '/docs/getting-started/',
},
{
from: '/docs/getting-started/configuration',
to: '/docs/getting-started/#next-steps',
},
],
},
],
+18 -7
View File
@@ -42,22 +42,28 @@
],
"Getting Started": [
"getting-started/index",
"getting-started/configuration",
"getting-started/create-an-app",
{
"type": "category",
"label": "App configuration",
"label": "Configuring Backstage",
"items": [
"getting-started/config/database",
"getting-started/config/authentication",
"getting-started/configure-app-with-plugins",
"getting-started/app-custom-theme",
"getting-started/homepage"
]
},
{
"type": "category",
"label": "Using Backstage",
"items": [
"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",
"getting-started/getting-involved",
"getting-started/project-structure"
"getting-started/concepts"
],
"Local Development": [
{
@@ -515,6 +521,11 @@
],
"FAQ": ["faq/index", "faq/product", "faq/technical"],
"Accessibility": ["accessibility/index"],
"Contribute": [
"contribute/index",
"contribute/getting-involved",
"contribute/project-structure"
],
"References": ["references/glossary"]
}
}