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

feat: the whole docs structure

Browse Source 
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com>
Co-authored-by: Ben Lambert <ben@blam.sh>
This commit is contained in:
Ivan Shmidt
2020-08-12 15:20:20 +02:00
parent 0867d3dc30
commit 882728ae1d
67 changed files with 352 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files
microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.md
+1 -1
View File
@@ -50,7 +50,7 @@ yarn start
And you are good to go! 👍
Read the full documentation on how to [create an app](https://github.com/spotify/backstage/blob/master/docs/create-an-app.md) on GitHub.
Read the full documentation on how to [create an app](https://github.com/spotify/backstage/blob/master/docs/getting-started/create-an-app.md) on GitHub.
## What do I get? (Let's get technical...)
microsite/i18n/en.json
+71 -50
View File
@@ -6,73 +6,82 @@
"tagline": "An open platform for building developer portals",
"docs": {
"api/backend": {
"title": "api/backend"
"title": "Backend"
},
"api/utility-apis": {
"title": "api/utility-apis"
"title": "Utility APIs"
},
"architecture-decisions/adr001-add-adr-log": {
"title": "architecture-decisions/adr001-add-adr-log"
"architecture-decisions/adrs-adr001": {
"title": "ADR001: Architecture Decision Record (ADR) log",
"sidebar_label": "ADR001"
},
"architecture-decisions/adr002-default-catalog-file-format": {
"title": "architecture-decisions/adr002-default-catalog-file-format"
"architecture-decisions/adrs-adr002": {
"title": "ADR002: Default Software Catalog File Format",
"sidebar_label": "ADR002"
},
"architecture-decisions/adr003-avoid-default-exports": {
"title": "architecture-decisions/adr003-avoid-default-exports"
"architecture-decisions/adrs-adr003": {
"title": "ADR003: Avoid Default Exports and Prefer Named Exports",
"sidebar_label": "ADR003"
},
"architecture-decisions/adr004-module-export-structure": {
"title": "architecture-decisions/adr004-module-export-structure"
"architecture-decisions/adrs-adr004": {
"title": "ADR004: Module Export Structure",
"sidebar_label": "ADR004"
},
"architecture-decisions/adr005-catalog-core-entities": {
"title": "architecture-decisions/adr005-catalog-core-entities"
"architecture-decisions/adrs-adr005": {
"title": "ADR005: Catalog Core Entities",
"sidebar_label": "ADR005"
},
"architecture-decisions/adr006-avoid-react-fc": {
"title": "architecture-decisions/adr006-avoid-react-fc"
"architecture-decisions/adrs-adr006": {
"title": "ADR006: Avoid React.FC and React.SFC",
"sidebar_label": "ADR006"
},
"architecture-decisions/adr007-use-msw-to-mock-service-requests": {
"title": "architecture-decisions/adr007-use-msw-to-mock-service-requests"
"architecture-decisions/adrs-adr007": {
"title": "ADR007: Use MSW to mock http requests",
"sidebar_label": "ADR007"
},
"architecture-decisions/adr008-default-catalog-file-name": {
"title": "architecture-decisions/adr008-default-catalog-file-name"
"architecture-decisions/adrs-adr008": {
"title": "ADR008: Default Catalog File Name",
"sidebar_label": "ADR008"
},
"architecture-decisions/index": {
"title": "architecture-decisions/index"
"architecture-decisions/adrs-overview": {
"title": "Architecture Decision Records (ADR)",
"sidebar_label": "Overview"
},
"auth/add-auth-provider": {
"title": "auth/add-auth-provider"
"title": "Adding authentication providers"
},
"auth/auth-backend": {
"title": "auth/auth-backend"
"title": "Auth backend"
},
"auth/glossary": {
"title": "auth/glossary"
"title": "Glossary"
},
"auth/index": {
"title": "auth/index"
"title": "User Authentication and Authorization in Backstage"
},
"auth/oauth": {
"title": "auth/oauth"
"title": "OAuth and OpenID Connect"
},
"conf/defining": {
"title": "conf/defining"
"title": "Defining Configuration for your Plugin"
},
"conf/index": {
"title": "conf/index"
"title": "Static Configuration in Backstage"
},
"conf/reading": {
"title": "conf/reading"
"title": "Reading Backstage Configuration"
},
"conf/writing": {
"title": "conf/writing"
"title": "Writing Backstage Configuration Files"
},
"dls/contributing-to-storybook": {
"title": "dls/contributing-to-storybook"
"title": "Contributing to Storybook"
},
"dls/design": {
"title": "dls/design"
"title": "Design"
},
"dls/figma": {
"title": "dls/figma"
"title": "Figma"
},
"FAQ": {
"title": "FAQ"
@@ -85,10 +94,10 @@
"sidebar_label": "YAML File Format"
},
"features/software-catalog/extending-the-model": {
"title": "features/software-catalog/extending-the-model"
"title": "Extending the model"
},
"features/software-catalog/external-integrations": {
"title": "features/software-catalog/external-integrations"
"title": "External integrations"
},
"features/software-catalog/software-catalog-overview": {
"title": "Backstage Service Catalog (alpha)"
@@ -97,7 +106,7 @@
"title": "features/software-catalog/populating"
},
"features/software-catalog/system-model": {
"title": "features/software-catalog/system-model"
"title": "System Model"
},
"features/software-templates/adding-templates": {
"title": "Adding your own Templates"
@@ -118,31 +127,34 @@
"title": "Software Templates"
},
"features/techdocs/concepts": {
"title": "features/techdocs/concepts"
"title": "Concepts"
},
"features/techdocs/creating-and-publishing": {
"title": "features/techdocs/creating-and-publishing"
"title": "Creating and publishing your docs",
"sidebar_label": "Creating and Publishing Documentation"
},
"features/techdocs/FAQ": {
"title": "features/techdocs/FAQ"
"features/techdocs/faqs": {
"title": "TechDocs FAQ",
"sidebar_label": "FAQ"
},
"features/techdocs/getting-started": {
"title": "features/techdocs/getting-started"
"title": "Getting Started"
},
"features/techdocs/techdocs-overview": {
"title": "TechDocs Documentation"
"title": "TechDocs Documentation",
"sidebar_label": "Overview"
},
"getting-started/app-custom-theme": {
"title": "Customize the look-and-feel of your App"
},
"getting-started/configure-app-with-plugins": {
"title": "getting-started/configure-app-with-plugins"
"title": "Configuring App with plugins"
},
"getting-started/create-an-app": {
"title": "Create an App"
},
"getting-started/deployment-k8s": {
"title": "getting-started/deployment-k8s"
"title": "Kubernetes"
},
"getting-started/deployment-other": {
"title": "Other"
@@ -169,7 +181,7 @@
"title": "Project roadmap"
},
"overview/support": {
"title": "overview/support"
"title": "Support and community"
},
"overview/what-is-backstage": {
"title": "What is Backstage?"
@@ -211,13 +223,13 @@
"title": "README"
},
"reference/createPlugin-feature-flags": {
"title": "reference/createPlugin-feature-flags"
"title": "createPlugin - feature flags"
},
"reference/createPlugin-router": {
"title": "reference/createPlugin-router"
"title": "createPlugin - router"
},
"reference/createPlugin": {
"title": "reference/createPlugin"
"title": "createPlugin"
},
"reference/utility-apis/AlertApi": {
"title": "reference/utility-apis/AlertApi"
@@ -253,7 +265,7 @@
"title": "reference/utility-apis/ProfileInfoApi"
},
"reference/utility-apis/README": {
"title": "reference/utility-apis/README"
"title": "Utility API References"
},
"reference/utility-apis/SessionStateApi": {
"title": "reference/utility-apis/SessionStateApi"
@@ -262,7 +274,7 @@
"title": "reference/utility-apis/StorageApi"
},
"tutorials/index": {
"title": "tutorials/index"
"title": "Overview"
}
},
"links": {
@@ -277,7 +289,16 @@
"Overview": "Overview",
"Getting Started": "Getting Started",
"Features": "Features",
"Plugins": "Plugins"
"Plugins": "Plugins",
"Configuration": "Configuration",
"Auth and identity": "Auth and identity",
"Designing for Backstage": "Designing for Backstage",
"API references": "API references",
"Tutorials": "Tutorials",
"Architecture Decision Records (ADRs)": "Architecture Decision Records (ADRs)",
"Contribute": "Contribute",
"Support": "Support",
"FAQ": "FAQ"
}
},
"pages-strings": {
microsite/sidebars.json
+49 -16
View File
@@ -48,16 +48,10 @@
"ids": [
"features/software-templates/software-templates-index",
"features/software-templates/adding-templates",
{
"type": "subcategory",
"label": "Extending the Scaffolder",
"ids": [
"features/software-templates/extending/extending-index",
"features/software-templates/extending/extending-templater",
"features/software-templates/extending/extending-publisher",
"features/software-templates/extending/extending-preparer"
]
}
"features/software-templates/extending/extending-index",
"features/software-templates/extending/extending-templater",
"features/software-templates/extending/extending-publisher",
"features/software-templates/extending/extending-preparer"
]
},
{
@@ -65,10 +59,10 @@
"label": "Docs-like-code",
"ids": [
"features/techdocs/techdocs-overview",
"features/techdocs/techdocs-getting-started",
"features/techdocs/techdocs-concepts",
"features/techdocs/techdocs-creating-and-publishing",
"features/techdocs/techdocs-faqs"
"features/techdocs/getting-started",
"features/techdocs/concepts",
"features/techdocs/creating-and-publishing",
"features/techdocs/faqs"
]
}
],
@@ -104,12 +98,51 @@
"conf/writing",
"conf/defining"
],
"Authentication and identity": [
"Auth and identity": [
"auth/index",
"auth/add-auth-provider",
"auth/auth-backend",
"auth/oauth",
"auth/glossary"
]
],
"Designing for Backstage": [
"dls/design",
"dls/contributing-to-storybook",
"dls/figma"
],
"API references": [
{
"type": "subcategory",
"label": "TypeScript API",
"ids": [
"api/utility-apis",
"reference/utility-apis/README",
"reference/createPlugin",
"reference/createPlugin-feature-flags",
"reference/createPlugin-router"
]
},
{
"type": "subcategory",
"label": "Backend APIs",
"ids": ["api/backend"]
}
],
"Tutorials": ["tutorials/index"],
"Architecture Decision Records (ADRs)": [
"architecture-decisions/adrs-overview",
"architecture-decisions/adrs-adr001",
"architecture-decisions/adrs-adr002",
"architecture-decisions/adrs-adr003",
"architecture-decisions/adrs-adr004",
"architecture-decisions/adrs-adr005",
"architecture-decisions/adrs-adr006",
"architecture-decisions/adrs-adr007",
"architecture-decisions/adrs-adr008"
],
"Contribute": ["../CONTRIBUTING"],
"Support": ["overview/support"],
"FAQ": ["FAQ"]
}
}