docs: fix broken links

2020-08-11 12:21:15 +02:00
parent 7763657a17
commit f69a2804ae
9 changed files with 31 additions and 22 deletions
@@ -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)
@@ -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.
@@ -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)

@@ -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

@@ -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.
@@ -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

@@ -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

@@ -0,0 +1 @@
+# TODO
@@ -0,0 +1 @@
+# TODO