[Docs] Fix relative paths to code (#1662)

* [Docs] Fix relative paths to code

* Update create-a-plugin.md

* Link to existing plugins

* Update README.md

* Update README.md

* Review edits
This commit is contained in:
Stefan Ålund
2020-07-16 09:17:43 +02:00
committed by GitHub
parent 0ea6125479
commit ce30c43d24
14 changed files with 46 additions and 28 deletions
+1 -1
View File
@@ -52,7 +52,7 @@ better yet, a pull request.
- [Overview](plugins/index.md)
- [Existing plugins](plugins/existing-plugins.md)
- [Creating a new plugin](plugins/create-a-plugin.md)
- [Developing a plugin](plugins/developing-plugins.md)
- [Developing a plugin](plugins/plugin-development.md)
- [Structure of a plugin](plugins/structure-of-a-plugin.md)
- Backends and APIs
- [Proxying](plugins/proxying.md)
+8 -6
View File
@@ -9,10 +9,11 @@ to various third party APIs.
There are occasions when the user wants to perform actions towards third party
services that require authorization via OAuth. Backstage provides standardized
[Utility APIs](../api/utility-apis.md) such as the
[GoogleAuthApi](../../packages/core-api/src/apis/definitions/auth.ts) for that
use-case. Backstage also includes a set of implementations of these APIs that
integrate with the [auth-backend](../../plugins/auth-backend) plugin to provide
a popup-based OAuth flow.
[GoogleAuthApi](https://github.com/spotify/backstage/blob/master/packages/core-api/src/apis/definitions/auth.ts)
for that use-case. Backstage also includes a set of implementations of these
APIs that integrate with the
[auth-backend](https://github.com/spotify/backstage/tree/master/plugins/auth-backend)
plugin to provide a popup-based OAuth flow.
## Background
@@ -51,8 +52,9 @@ easier to make authenticated requests inside a plugin.
## OAuth Flow
The following describes the OAuth flow implemented by the
[auth-backend](../../plugins/auth-backend) and
[DefaultAuthConnector](../../packages/core-api/src/lib/AuthConnector/DefaultAuthConnector.ts)
[auth-backend](https://github.com/spotify/backstage/tree/master/plugins/auth-backend)
and
[DefaultAuthConnector](https://github.com/spotify/backstage/blob/master/packages/core-api/src/lib/AuthConnector/DefaultAuthConnector.ts)
in `@backstage/core-api`.
Component and APIs can request Access or ID Tokens from any available Auth
@@ -50,7 +50,8 @@ system resources and slow things down.
## Package Scripts
There are many commands to be found in the root [package.json](package.json),
There are many commands to be found in the root
[package.json](https://github.com/spotify/backstage/blob/master/package.json),
here are some useful ones:
```python
@@ -80,7 +81,9 @@ yarn diff # Make sure all plugins are up to date with the latest plugin template
yarn create-plugin # Create a new plugin
```
> See [package.json](/package.json) for other yarn commands/options.
> See
> [package.json](https://github.com/spotify/backstage/blob/master/package.json)
> for other yarn commands/options.
[Next Step - Create a Backstage plugin](../plugins/create-a-plugin.md)
+1 -1
View File
@@ -24,7 +24,7 @@ for your new plugin directly by navigating to
`http://localhost:3000/my-plugin`._
<p align='center'>
<img src='https://github.com/spotify/backstage/raw/master/docs/getting-started/my-plugin_screenshot.png' width='600' alt='my plugin'>
<img src='https://github.com/spotify/backstage/raw/master/docs/plugins/my-plugin_screenshot.png' width='600' alt='my plugin'>
</p>
You can also serve the plugin in isolation by running `yarn start` in the plugin
View File
+11
View File
@@ -0,0 +1,11 @@
# Existing plugins
## Open source plugins
The full list of open source plugins can be found
[here](https://github.com/spotify/backstage/tree/master/plugins).
## Plugin gallery
TODO: In the future we would like to have something similar to
https://grafana.com/grafana/plugins
+3 -4
View File
@@ -5,15 +5,14 @@ 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.
[design guidelines](../dls/design.md) we ensure the the overall user experience
stays consistent between plugins.
![plugin](my-plugin_screenshot.png)
## Creating a plugin
To create a plugin, follow the steps outlined
[here](https://github.com/spotify/backstage/blob/master/docs/getting-started/create-a-plugin.md).
To create a plugin, follow the steps outlined [here](create-a-plugin.md).
## Suggesting a plugin
+4 -3
View File
@@ -3,9 +3,10 @@
## NPM
NPM packages are published through CI/CD in the
[.github/workflows/master.yml](../../.github/workflows/master.yml) workflow.
Every commit that is merged to master will be checked for new versions of all
public packages, and any new versions will automatically be published to NPM.
[.github/workflows/master.yml](https://github.com/spotify/backstage/blob/master/.github/workflows/master.yml)
workflow. Every commit that is merged to master will be checked for new versions
of all public packages, and any new versions will automatically be published to
NPM.
### Creating a new release
+1 -1
View File
@@ -102,6 +102,6 @@ environment you will probably face challenges like CORS policies and/or
backend-side authorization. To smooth this process out you can use proxy -
either the one you already have (like nginx/haproxy/etc) or the proxy-backend
plugin that we provide for the backstage backend.
[Read more](../../plugins/proxy-backend/README.md)
[Read more](https://github.com/spotify/backstage/blob/master/plugins/proxy-backend/README.md)
[Back to Getting Started](../README.md)