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

Merge pull request #3862 from adamdmharvey/update-docs

Browse Source 
docs: Minor clarifications
This commit is contained in:
Adam Harvey
2020-12-29 12:05:11 -05:00
committed by GitHub
parent e1bdb9326f bd5de83e78
commit a9aac9a558
4 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/index.md
+1 -1
View File
@@ -33,4 +33,4 @@ that someone else will pick up the work.
If your plugin isn't supposed to live as a standalone page, but rather needs to
be presented as a part of a Service Catalog (e.g. a separate tab or a card on an
"Overview" tab), then check out
[the instruction](integrating-plugin-into-service-catalog.md). on how to do it.
[the instruction](integrating-plugin-into-service-catalog.md) on how to do it.
docs/support/project-structure.md
+2 -2
View File
@@ -41,8 +41,8 @@ the code.
appreciate contributions in here and encourage them being kept up to date.
- [`docs/`](https://github.com/backstage/backstage/tree/master/docs) - This is
where we keep all of our documentation Markdown files. These ends up on
http://backstage.io/docs. Just keep in mind that changes to the
where we keep all of our documentation Markdown files. These end up on
https://backstage.io/docs. Just keep in mind that changes to the
[`sidebars.json`](https://github.com/backstage/backstage/blob/master/microsite/sidebars.json)
file may be needed as sections are added/removed.
packages/storybook/README.md
+2 -2
View File
@@ -1,7 +1,7 @@
# storybook
This package provides a storybook build for Backstage. See [http://backstage.io/storybook](http://http://backstage.io/storybook)
This package provides a Storybook build for Backstage. See https://backstage.io/storybook/.
## Why is this not part of `@backstage/core`?
This separate storybook package exists because of dependency conflicts with `@backstage/cli`. It uses nohoist to avoid the conflicts, and since you can only use that in private packages it has to be separated out of `@backstage/core`.
This separate storybook package exists because of dependency conflicts with `@backstage/cli`. It uses `nohoist` to avoid the conflicts, and since you can only use that in private packages it has to be separated out of `@backstage/core`.
plugins/README.md
+4 -6
View File
@@ -1,14 +1,12 @@
# Plugins
Backstage is a single-page application composed of a set of plugins.
Backstage is a single-page application composed of a set of plugins. This folder holds numerous plugins that are managed by this repository.
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/backstage/backstage/blob/master/docs/dls/design.md) we ensure the overall user experience stays consistent between plugins.
For more information about the plugin ecosystem, see the documentation here:
![plugin](../docs/assets/my-plugin_screenshot.png)
> https://backstage.io/docs/plugins/
## Creating a plugin
To create a plugin, follow the steps outlined [here](https://github.com/backstage/backstage/blob/master/docs/plugins/create-a-plugin.md).
You can also see the [Plugin Marketplace](https://backstage.io/plugins) for other open source plugins you can add to your Backstage instance.
## Suggesting a plugin