backstage
/
mkdocs.yml
220 строк · 12.1 Кб
1site_name: 'Backstage'2site_description: 'Main documentation for Backstage features and platform APIs'3repo_url: https://github.com/backstage/backstage4edit_uri: edit/master/docs5
6plugins:7- techdocs-core8
9# For sidebar navigation on https://backstage.io/, see `microsite/sidebars.json`
10nav:11- Overview:12- What is Backstage?: 'overview/what-is-backstage.md'13- Architecture overview: 'overview/architecture-overview.md'14- Project Roadmap: 'overview/roadmap.md'15- Vision: 'overview/vision.md'16- The Spotify Story: 'overview/background.md'17- Strategies for adopting: 'overview/adopting.md'18- Release & Versioning Policy: 'overview/versioning-policy.md'19- Backstage Threat Model: 'overview/threat-model.md'20- Support and community: 'overview/support.md'21- Logo assets: 'overview/logos.md'22- Getting Started:23- Getting Started: 'getting-started/index.md'24- Create an App: 'getting-started/create-an-app.md'25- App configuration:26- Configuring App with plugins: 'getting-started/configure-app-with-plugins.md'27- Customize the look-and-feel of your App: 'getting-started/app-custom-theme.md'28- Keeping Backstage Updated: 'getting-started/keeping-backstage-updated.md'29- Key Concepts: 'getting-started/concepts.md'30- Project Structure: 'getting-started/project-structure.md'31- Local Development:32- CLI:33- Overview: 'local-dev/cli-overview.md'34- Build System: 'local-dev/cli-build-system.md'35- Commands: 'local-dev/cli-commands.md'36- Linking in Local Packages: 'local-dev/linking-local-packages.md'37- Core Features:38- Software Catalog:39- Overview: 'features/software-catalog/index.md'40- The Life of an Entity: 'features/software-catalog/life-of-an-entity.md'41- Catalog Configuration: 'features/software-catalog/configuration.md'42- System Model: 'features/software-catalog/system-model.md'43- YAML File Format: 'features/software-catalog/descriptor-format.md'44- Entity References: 'features/software-catalog/references.md'45- Well-known Annotations: 'features/software-catalog/well-known-annotations.md'46- Well-known Relations: 'features/software-catalog/well-known-relations.md'47- Well-known Statuses: 'features/software-catalog/well-known-statuses.md'48- Extending the model: 'features/software-catalog/extending-the-model.md'49- External integrations: 'features/software-catalog/external-integrations.md'50- Catalog Customization: 'features/software-catalog/catalog-customization.md'51- API: 'features/software-catalog/api.md'52- Kubernetes:53- Overview: 'features/kubernetes/index.md'54- Installation: 'features/kubernetes/installation.md'55- Configuration: 'features/kubernetes/configuration.md'56- Authentication: 'features/kubernetes/authentication.md'57- Troubleshooting: 'features/kubernetes/troubleshooting.md'58- Software Templates:59- Overview: 'features/software-templates/index.md'60- Configuration: 'features/software-templates/configuration.md'61- Adding your own Templates: 'features/software-templates/adding-templates.md'62- Writing Templates: 'features/software-templates/writing-templates.md'63- Input Examples: 'features/software-templates/input-examples.md'64- Builtin Actions: 'features/software-templates/builtin-actions.md'65- Writing Custom Actions: 'features/software-templates/writing-custom-actions.md'66- Writing Custom Step Layouts: 'features/software-templates/writing-custom-step-layouts.md'67- Migrating from v1beta2 to v1beta3 templates: 'features/software-templates/migrating-from-v1beta2-to-v1beta3.md'68- Backstage Search:69- Overview: 'features/search/README.md'70- Getting Started: 'features/search/getting-started.md'71- Concepts: 'features/search/concepts.md'72- Search Architecture: 'features/search/architecture.md'73- Search Engines: 'features/search/search-engines.md'74- HOW TO guides: 'features/search/how-to-guides.md'75- TechDocs:76- Overview: 'features/techdocs/README.md'77- Getting Started: 'features/techdocs/getting-started.md'78- Concepts: 'features/techdocs/concepts.md'79- TechDocs Architecture: 'features/techdocs/architecture.md'80- Creating and Publishing Documentation: 'features/techdocs/creating-and-publishing.md'81- TechDocs Configuration Options: 'features/techdocs/configuration.md'82- Using Cloud Storage: 'features/techdocs/using-cloud-storage.md'83- Configuring CI/CD to generate and publish TechDocs sites: 'features/techdocs/configuring-ci-cd.md'84- CLI: 'features/techdocs/cli.md'85- HOW TO guides: 'features/techdocs/how-to-guides.md'86- Troubleshooting: 'features/techdocs/troubleshooting.md'87- FAQ: 'features/techdocs/FAQ.md'88- Integrations:89- Overview: 'integrations/index.md'90- AWS S3:91- Locations: 'integrations/aws-s3/locations.md'92- Discovery: 'integrations/aws-s3/discovery.md'93- Azure:94- Locations: 'integrations/azure/locations.md'95- Discovery: 'integrations/azure/discovery.md'96- Org Data: 'integrations/azure/org.md'97- Bitbucket Cloud:98- Locations: 'integrations/bitbucketCloud/locations.md'99- Discovery: 'integrations/bitbucketCloud/discovery.md'100- Bitbucket Server:101- Locations: 'integrations/bitbucketServer/locations.md'102- Discovery: 'integrations/bitbucketServer/discovery.md'103- Datadog:104- Installation: 'integrations/datadog-rum/installation.md'105- Gerrit:106- Locations: 'integrations/gerrit/locations.md'107- Discovery: 'integrations/gerrit/discovery.md'108- GitHub:109- Locations: 'integrations/github/locations.md'110- Discovery: 'integrations/github/discovery.md'111- Org Data: 'integrations/github/org.md'112- GitHub Apps: 'integrations/github/github-apps.md'113- GitLab:114- Locations: 'integrations/gitlab/locations.md'115- Discovery: 'integrations/gitlab/discovery.md'116- Google GCS:117- Locations: 'integrations/google-cloud-storage/locations.md'118- LDAP:119- Org Data: 'integrations/ldap/org.md'120- Plugins:121- Intro to plugins: 'plugins/index.md'122- Existing plugins: 'plugins/existing-plugins.md'123- Create a Backstage Plugin: 'plugins/create-a-plugin.md'124- Plugin Development: 'plugins/plugin-development.md'125- Structure of a plugin: 'plugins/structure-of-a-plugin.md'126- Integrate into the Software Catalog: 'plugins/integrating-plugin-into-software-catalog.md'127- Composability System: 'plugins/composability.md'128- Plugin Analytics: 'plugins/analytics.md'129- Feature Flags: 'plugins/feature-flags.md'130- OpenAPI:131- Schema-first plugins with OpenAPI (Experimental): 'openapi/01-getting-started.md'132- Generate a client from your OpenAPI spec: 'openapi/generate-client.md'133- Validate your OpenAPI spec against test data: 'openapi/test-case-validation.md'134- Backends and APIs:135- Proxying: 'plugins/proxying.md'136- Backend plugin: 'plugins/backend-plugin.md'137- Call existing API: 'plugins/call-existing-api.md'138- URL Reader: 'plugins/url-reader.md'139- Testing:140- Testing with Jest: 'plugins/testing.md'141- Publishing:142- Publish private: 'plugins/publish-private.md'143- Add to Directory: 'plugins/add-to-directory.md'144- Observability: 'plugins/observability.md'145- Configuration:146- Static Configuration in Backstage: 'conf/index.md'147- Reading Backstage Configuration: 'conf/reading.md'148- Writing Backstage Configuration: 'conf/writing.md'149- Defining Configuration for your Plugin: 'conf/defining.md'150- Authentication and identity:151- Adding Authentication: 'auth/index.md'152- Included providers:153- Atlassian: 'auth/atlassian/provider.md'154- Auth0: 'auth/auth0/provider.md'155- Azure: 'auth/microsoft/provider.md'156- Azure EasyAuth: 'auth/microsoft/azure-easyauth.md'157- Bitbucket: 'auth/bitbucket/provider.md'158- Bitbucket Server: 'auth/bitbucketServer/provider.md'159- Cloudflare Access: 'auth/cloudflare/access.md'160- GitHub: 'auth/github/provider.md'161- GitLab: 'auth/gitlab/provider.md'162- Google: 'auth/google/provider.md'163- Google IAP: 'auth/google/gcp-iap-auth.md'164- OAuth2Proxy: 'auth/oauth2-proxy/provider.md'165- Okta: 'auth/okta/provider.md'166- OneLogin: 'auth/onelogin/provider.md'167- Sign in resolvers: 'auth/identity-resolver.md'168- OAuth and OpenID Connect: 'auth/oauth.md'169- OIDC provider from scratch: 'auth/oidc.md'170- Contributing New Providers: 'auth/add-auth-provider.md'171- Service to Service Auth: 'auth/service-to-service-auth.md'172- Troubleshooting Auth: 'auth/troubleshooting.md'173- Deployment:174- Deploying Backstage: 'deployment/index.md'175- Scaling: 'deployment/scaling.md'176- Docker: 'deployment/docker.md'177- Kubernetes: 'deployment/k8s.md'178- Heroku: 'deployment/heroku.md'179- Koyeb: 'deployment/koyeb.md'180- Designing for Backstage:181- Design: 'dls/design.md'182- Component Design Guidelines: 'dls/component-design-guidelines.md'183- Contributing to Storybook: 'dls/contributing-to-storybook.md'184- Figma: 'dls/figma.md'185- API Reference:186- Guides:187- Utility APIs: 'api/utility-apis.md'188- Deprecations: 'api/deprecations.md'189- Tutorials:190- Future developer journey: 'tutorials/journey.md'191- React Router 6.0 Migration: 'tutorials/react-router-stable-migration.md'192- Package Role Migration: 'tutorials/package-role-migration.md'193- Migrating away from @backstage/core: 'tutorials/migrating-away-from-core.md'194- Adding Custom Plugin to Existing Monorepo App: 'tutorials/quickstart-app-plugin.md'195- Switching Backstage from SQLite to PostgreSQL: 'tutorials/switching-sqlite-postgres.md'196- Using the Backstage Proxy from Within a Plugin: 'tutorials/using-backstage-proxy-within-plugin.md'197- Migration to Yarn 3: 'tutorials/yarn-migration.md'198- Migration to Material UI v5: 'tutorials/migrate-to-mui5.md'199- Setup OpenTelemetry: 'tutorials/setup-opentelemetry.md'200- Architecture Decision Records (ADRs):201- Overview: 'architecture-decisions/index.md'202- ADR001 - Architecture Decision Record (ADR) log: 'architecture-decisions/adr001-add-adr-log.md'203- ADR002 - Default Software Catalog File Format: 'architecture-decisions/adr002-default-catalog-file-format.md'204- ADR003 - Avoid Default Exports and Prefer Named Exports: 'architecture-decisions/adr003-avoid-default-exports.md'205- ADR004 - Module Export Structure: 'architecture-decisions/adr004-module-export-structure.md'206- ADR005 - Catalog Core Entities: 'architecture-decisions/adr005-catalog-core-entities.md'207- ADR006 - Avoid React.FC and React.SFC: 'architecture-decisions/adr006-avoid-react-fc.md'208- ADR007 - Use MSW for Network Request Mocking: 'architecture-decisions/adr007-use-msw-to-mock-service-requests.md'209- ADR008 - Default Catalog File Name: 'architecture-decisions/adr008-default-catalog-file-name.md'210- ADR009 - Entity References: 'architecture-decisions/adr009-entity-references.md'211- ADR010 - Luxon Date Library: 'architecture-decisions/adr010-luxon-date-library.md'212- ADR011 - Plugin Package Structure: 'architecture-decisions/adr011-plugin-package-structure.md'213- ADR012 - Plugin Package Structure: 'architecture-decisions/adr012-use-luxon-locale-and-date-presets.md'214- ADR013 - Plugin Package Structure: 'architecture-decisions/adr013-use-node-fetch.md'215- FAQ:216- Overview: 'faq/index.md'217- Product FAQ: 'faq/product.md'218- Technical FAQ: 'faq/technical.md'219- References:220- Glossary: 'references/glossary.md'221