From f69a2804ae93eaa7710eb380271b75216d154759 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 11 Aug 2020 12:21:15 +0200 Subject: [PATCH] docs: fix broken links --- docs/README.md | 6 +--- .../templates/default-plugin/README.md.hbs | 2 +- plugins/README.md | 2 +- plugins/gitops-profiles/README.md | 2 +- plugins/graphql/README.md | 31 ++++++++++++++----- plugins/sentry/README.md | 2 +- plugins/techdocs/README.md | 6 +--- plugins/techdocs/src/reader/README.md | 1 + .../src/reader/transformers/README.md | 1 + 9 files changed, 31 insertions(+), 22 deletions(-) create mode 100644 plugins/techdocs/src/reader/README.md create mode 100644 plugins/techdocs/src/reader/transformers/README.md diff --git a/docs/README.md b/docs/README.md index 2bda6a5aaa..cdbfbc5578 100644 --- a/docs/README.md +++ b/docs/README.md @@ -43,11 +43,7 @@ better yet, a pull request. - [Overview](features/techdocs/README.md) - [Getting Started](features/techdocs/getting-started.md) - [Concepts](features/techdocs/concepts.md) - - [Reading Documentation](features/techdocs/reading-documentation.md) - - [Writing Documentation](features/techdocs/writing-documentation.md) - - [Publishing Documentation](features/techdocs/publishing-documentation.md) - - [Contributing](features/techdocs/contributing.md) - - [Debugging](features/techdocs/debugging.md) + - [Creating and Publishing Documentation](features/techdocs/creating-and-publishing.md) - [FAQ](features/techdocs/FAQ.md) - Plugins - [Overview](plugins/index.md) diff --git a/packages/cli/templates/default-plugin/README.md.hbs b/packages/cli/templates/default-plugin/README.md.hbs index d6f2d65134..6d68ca8250 100644 --- a/packages/cli/templates/default-plugin/README.md.hbs +++ b/packages/cli/templates/default-plugin/README.md.hbs @@ -10,4 +10,4 @@ Your plugin has been added to the example app in this repository, meaning you'll You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. diff --git a/plugins/README.md b/plugins/README.md index 50f4395bd9..a7fe648bf7 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -2,7 +2,7 @@ Backstage is a single-page application composed of a set of plugins. -Our goal for the plugin ecosystem is that the definition of a plugin is flexible enough to allow you to expose pretty much any kind of infrastructure or software development tool as a plugin in Backstage. By following strong [design guidelines](https://github.com/spotify/backstage/blob/master/docs/design.md) we ensure the the overall user experience stays consistent between plugins. +Our goal for the plugin ecosystem is that the definition of a plugin is flexible enough to allow you to expose pretty much any kind of infrastructure or software development tool as a plugin in Backstage. By following strong [design guidelines](https://github.com/spotify/backstage/blob/master/docs/dls/design.md) we ensure the the overall user experience stays consistent between plugins. ![plugin](../docs/plugins/my-plugin_screenshot.png) diff --git a/plugins/gitops-profiles/README.md b/plugins/gitops-profiles/README.md index d083c97b84..472ea3cc4e 100644 --- a/plugins/gitops-profiles/README.md +++ b/plugins/gitops-profiles/README.md @@ -11,7 +11,7 @@ Your plugin has been added to the example app in this repository, meaning you'll You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. ## Use GitOps-API backend with Backstage diff --git a/plugins/graphql/README.md b/plugins/graphql/README.md index 3f85ec766e..ae58396880 100644 --- a/plugins/graphql/README.md +++ b/plugins/graphql/README.md @@ -1,13 +1,28 @@ -# graphql +# GraphQL Backend -Welcome to the graphql backend plugin! +## Getting Started -_This plugin was created through the Backstage CLI_ +This backend plugin can be started in a standalone mode from directly in this package +with `yarn start`. However, it will have limited functionality and that process is +most convenient when developing the plugin itself. -## Getting started +To run it within the backend do: -Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/graphql](http://localhost:3000/graphql). +1. Register the router in `packages/backend/src/index.ts`: -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +```ts +const graphqlEnv = useHotMemoize(module, () => createEnv('graphql')); + +const service = createServiceBuilder(module) + .loadConfig(configReader) + /** several different routers */ + .addRouter('/graphql', await graphql(graphqlEnv)); +``` + +2. Start the backend + +```bash +yarn workspace example-backend start +``` + +This will launch the full example backend. diff --git a/plugins/sentry/README.md b/plugins/sentry/README.md index cce2228094..73cca29d34 100644 --- a/plugins/sentry/README.md +++ b/plugins/sentry/README.md @@ -10,7 +10,7 @@ Your plugin has been added to the example app in this repository, meaning you'll You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. Needs SENTRY_TOKEN set in the environment for the backend to startup diff --git a/plugins/techdocs/README.md b/plugins/techdocs/README.md index b763679a1c..4a92c814a1 100644 --- a/plugins/techdocs/README.md +++ b/plugins/techdocs/README.md @@ -4,17 +4,13 @@ Welcome to the TechDocs plugin - Spotify's docs-like-code approach built directl **WIP: This plugin is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).** -## Sections - -- [MkDocs](./mkdocs/README.md) - ## Getting started Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/docs](http://localhost:3000/docs). You can also serve the plugin in isolation by running `yarn start` in the plugin directory. This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. ## Configuration diff --git a/plugins/techdocs/src/reader/README.md b/plugins/techdocs/src/reader/README.md new file mode 100644 index 0000000000..464090415c --- /dev/null +++ b/plugins/techdocs/src/reader/README.md @@ -0,0 +1 @@ +# TODO diff --git a/plugins/techdocs/src/reader/transformers/README.md b/plugins/techdocs/src/reader/transformers/README.md new file mode 100644 index 0000000000..464090415c --- /dev/null +++ b/plugins/techdocs/src/reader/transformers/README.md @@ -0,0 +1 @@ +# TODO