Merge pull request #1 from backstage/master

merge master #2
2021-05-13 20:31:34 +01:00
parent c6cc32b64e 1cfef4244e
commit 76b7d300ba
644 changed files with 25471 additions and 3577 deletions
@@ -1,3 +1,9 @@
+# Backstage Documentation
+
+This folder holds the service and configuration that runs Backstage's documentation hosted at https://backstage.io.
+
+It pulls content in from the [root `/docs`](../docs/) folder and builds it into the resulting HTML web site.
+
 This website was created with [Docusaurus](https://docusaurus.io/).

 # What's In This Document
@@ -10,6 +16,8 @@ This website was created with [Docusaurus](https://docusaurus.io/).

 # Getting Started

+Testing the web site locally is a great way to see what final website will look like after publishing, and is ideal for testing more complex changes, large updates to navigation, or complex page designs that may include special alignment, which may not otherwise be validated through continuous integration.
+
 ## Installation

 ```
@@ -22,7 +30,7 @@ $ yarn install
 $ yarn start
 ```

-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens up a browser window. Most content changes made to the `docs/` root folder are reflected live without having to restart the server.

 ## Build

@@ -57,9 +65,9 @@ my-docusaurus/
    siteConfig.js
 ```

-# Editing Content
+## Editing Content

-## Editing an existing docs page
+### Editing an existing docs page

 Edit docs by navigating to `docs/` and editing the corresponding document:

@@ -76,7 +84,7 @@ Edit me...

 For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)

-## Editing an existing blog post
+### Editing an existing blog post

 Edit blog posts by navigating to `website/blog` and editing the corresponding post:

@@ -93,9 +101,9 @@ Edit me...

 For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

-# Adding Content
+## Adding Content

-## Adding a new docs page to an existing sidebar
+### Adding a new docs page to an existing sidebar

 1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:

@@ -126,7 +134,7 @@ My new content here..

 For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)

-## Adding a new blog post
+### Adding a new blog post

 1. Make sure there is a header link to your blog in `website/siteConfig.js`:

@@ -157,7 +165,7 @@ Lorem Ipsum...

 For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

-## Adding items to your site's top navigation bar
+### Adding items to your site's top navigation bar

 1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:

@@ -181,7 +189,7 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e

 For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)

-## Adding custom pages
+### Adding custom pages

 1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
 1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
@@ -199,11 +207,11 @@ For more information about the navigation bar, click [here](https://docusaurus.i
 }
 ```

-For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
+Learn more about [Docusaurus custom pages](https://docusaurus.io/docs/en/custom-pages).

-# Full Documentation
+## Full Documentation

-Full documentation can be found on the [website](https://docusaurus.io/).
+Full documentation can be found on the [Docusaurus website](https://docusaurus.io/).

 ## Additional notes

@@ -45,7 +45,7 @@ The only thing you need to do is to start the app:

 ```bash
 cd my-app
-yarn start
+yarn dev
 ```

 And you are good to go! 👍
@@ -101,18 +101,12 @@ We provide a collection of public Backstage plugins (look for packages with the
 Install in your app’s package folder (`<root>/packages/app`) with:

 ```bash
+# From your Backstage root directory
+cd packages/app
 yarn add @backstage/plugin-<plugin-name>
 ```

-Then add it to your app's `plugin.ts` file to import and register it:
-
-`<root>/packages/app/src/plugin.ts`:
-
-```js
-export { plugin as PluginName } from '@backstage/plugin-<plugin-name>';
-```
-
-A plugin registers its own `route` in the app — read the documentation for the specific plugin you are installing for more information on that.
+After that, you inject the plugin into the application where you want it to be exposed. Please read the documentation for the specific plugin you are installing for more information.

 ### Creating an internal plugin

@@ -5,7 +5,7 @@ authorUrl: https://github.com/spotify
 category: CI/CD
 description: Automate your development process with CI hosted in the cloud or on a private server.
 documentation: https://github.com/backstage/backstage/tree/master/plugins/circleci
-iconUrl: https://www.saaves.com/storage/brochure/logo-circleci-icon1583764538.png
+iconUrl: img/circleci.png
 npmPackageName: '@backstage/plugin-circleci'
 tags:
  - ci
@@ -5,7 +5,7 @@ authorUrl: https://github.com/spotify
 category: Discovery
 description: Visualize, understand and optimize your team's cloud costs.
 documentation: https://github.com/backstage/backstage/tree/master/plugins/cost-insights
-iconUrl: https://www.materialui.co/materialIcons/editor/monetization_on_white_192x192.png
+iconUrl: img/cost-insights.png
 npmPackageName: '@backstage/plugin-cost-insights'
 tags:
  - web
@@ -0,0 +1,9 @@
+---
+title: GitHub Release Manager
+author: '@Spotify'
+authorUrl: https://github.com/spotify
+category: Release management
+description: Manage releases without having to juggle git commands
+documentation: https://github.com/backstage/backstage/tree/master/plugins/git-release-manager
+iconUrl: img/git-release-manager-logo.svg
+npmPackageName: '@backstage/plugin-git-release-manager'
@@ -18,7 +18,7 @@
    "@spotify/prettier-config": "^10.0.0",
    "docusaurus": "^2.0.0-alpha.70",
    "js-yaml": "^4.1.0",
-    "prettier": "^2.2.1"
+    "prettier": "^2.3.0"
  },
  "prettier": "@spotify/prettier-config"
 }
@@ -431,7 +431,7 @@ class Index extends React.Component {
              <Block.SmallTitle small>Pick a cloud, any cloud</Block.SmallTitle>
              <Block.Paragraph>
                Since Backstage uses the Kubernetes API, it's cloud agnostic —
-                so it works no matter which cloud provide or managed Kubernetes
+                so it works no matter which cloud provider or managed Kubernetes
                service you use, and even works in multi-cloud orgs
              </Block.Paragraph>
            </Block.TextBox>
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="500px" height="500px" viewBox="0 0 500 500" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Export</title>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="ship" transform="translate(249.680798, 211.000000) scale(-1, 1) translate(-249.680798, -211.000000) translate(35.680798, -39.000000)" fill-rule="nonzero">
+            <g id="Flamez" transform="translate(279.925187, 455.280081) rotate(-90.000000) translate(-279.925187, -455.280081) translate(235.660848, 411.639183)">
+                <path d="M77.6240648,9.79348504 C64.5660848,-3.26449501 42.8017456,-3.26449501 29.7437656,9.79348504 C11.6072319,27.9300187 0.725685786,80.8882481 8.85963511e-15,83.064682 C8.85963511e-15,84.5154302 8.85963511e-15,85.241116 0.725685786,85.9668017 C2.17643392,86.6924875 3.62780549,86.6924875 5.07855362,86.6924875 C7.25498753,85.9668017 60.213217,75.810318 78.3497506,56.9487219 C91.4077307,43.8901185 91.4077307,22.8514651 77.6240648,9.79348504 Z" id="Path" fill="#F79548"></path>
+                <path d="M75.4476309,10.5185474 C68.9183292,3.98924564 58.036783,3.98924564 51.5074813,10.5185474 C42.0766833,19.9493454 36.9981297,46.0659289 36.9981297,46.7916147 C36.9981297,47.5173005 36.9981297,48.2423628 37.7238155,48.2423628 C38.4495012,48.9680486 38.4495012,48.9680486 39.1745636,48.9680486 C40.6253117,48.9680486 66.7418953,43.1644327 75.4476309,34.458697 C81.9769327,27.9300187 81.9769327,17.0478491 75.4476309,10.5185474 Z" id="Path" fill="#FCBB76"></path>
+            </g>
+            <path d="M216.186409,55.2394015 C218.49257,55.2394015 220.58047,56.1742348 222.091833,57.6855981 C223.534498,59.128263 224.451854,61.0962436 224.532269,63.2779325 L224.53803,63.5910224 L224.53803,91.005836 L353.369587,261.704121 C354.323776,262.968115 354.87911,264.447677 355.019478,265.965658 C355.159883,267.484039 354.88511,269.040862 354.179061,270.458806 C353.472845,271.876805 352.395871,273.033852 351.099552,273.836436 C349.895645,274.581806 348.502551,275.021453 347.041547,275.080457 L346.703242,275.087282 L224.53803,275.087282 L224.53803,303.904613 L346.684539,303.904613 C348.308638,303.904613 349.858968,304.375354 351.174692,305.21426 C352.490519,306.053232 353.571696,307.260417 354.25731,308.732969 C354.942424,310.205367 355.16974,311.809443 354.964363,313.356104 C354.77365,314.792333 354.20983,316.179047 353.29311,317.364769 L353.075304,317.634761 L309.451382,369.468132 C307.930114,371.274871 305.719044,372.349921 303.368443,372.436371 L303.061097,372.44202 L124.602244,372.44202 C122.240117,372.44202 119.994057,371.442358 118.41433,369.699238 L118.212103,369.467679 L74.5886595,317.634759 C73.5428392,316.392134 72.9047814,314.903039 72.6994228,313.356514 C72.494029,311.809724 72.7214803,310.205497 73.4066556,308.732969 C74.0917295,307.260659 75.1726391,306.053772 76.4882065,305.214939 C77.7099169,304.435952 79.1339993,303.974371 80.6313862,303.912406 L80.9781796,303.905237 L207.834788,303.905237 L207.834788,274.720698 L106.28616,274.720698 C103.979999,274.720698 101.892098,273.785865 100.380735,272.274502 C98.8693719,270.763138 97.9345387,268.675238 97.9345387,266.369077 C97.9345387,233.249109 111.496611,180.759139 130.891816,138.720038 C142.0216,114.595575 154.255888,95.1994886 167.266567,81.0803824 C183.02715,63.976526 199.471354,55.2394015 216.186409,55.2394015 Z M328.739655,320.607855 L98.9224399,320.607855 L128.488453,355.738155 L299.173642,355.738155 L328.739655,320.607855 Z M224.53803,118.732589 L224.53803,258.384663 L329.936488,258.384663 L224.53803,118.732589 Z M207.834165,73.0839035 C187.31365,78.5957312 165.169959,104.292863 146.058313,145.71761 C129.135086,182.399574 116.887708,227.020442 114.917014,258.016833 L114.917014,258.016833 L207.834165,258.016833 Z" id="Shape" stroke="#DDDDDD" stroke-width="2" fill="#E8E8E8" transform="translate(213.840829, 213.840711) rotate(45.000000) translate(-213.840829, -213.840711) "></path>
+        </g>
+    </g>
+</svg>
@@ -5197,10 +5197,10 @@ prepend-http@^2.0.0:
  resolved "https://registry.npmjs.org/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897"
  integrity sha1-6SQ0v6XqjBn0HN/UAddBo8gZ2Jc=

-prettier@^2.2.1:
-  version "2.2.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.2.1.tgz#795a1a78dd52f073da0cd42b21f9c91381923ff5"
-  integrity sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==
+prettier@^2.3.0:
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.3.0.tgz#b6a5bf1284026ae640f17f7ff5658a7567fc0d18"
+  integrity sha512-kXtO4s0Lz/DW/IJ9QdWhAf7/NmPWQXkFr/r/WkR3vyI+0v8amTDxiaQSLzs8NBlytfLWX/7uQUMIW677yLKl4w==

 prismjs@^1.22.0:
  version "1.23.0"