From 3fc5cb64fda0cce71164f11f850b130cc08bdbe4 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 00:53:47 -0500 Subject: [PATCH 1/8] Fix typo --- docs/plugins/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/index.md b/docs/plugins/index.md index dcef3f995c..32d523b2f5 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -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. From 282ed3ee65d7c031c23cdd355444ade6260b87ba Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 00:58:16 -0500 Subject: [PATCH 2/8] Clarify link --- docs/support/project-structure.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/support/project-structure.md b/docs/support/project-structure.md index bbba127c9a..a30288e85e 100644 --- a/docs/support/project-structure.md +++ b/docs/support/project-structure.md @@ -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. From 69d4991ccae5945cd789f726a98657671b49c43e Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 00:58:28 -0500 Subject: [PATCH 3/8] Fix link --- packages/storybook/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/storybook/README.md b/packages/storybook/README.md index 38708afe4b..3e88b54db0 100644 --- a/packages/storybook/README.md +++ b/packages/storybook/README.md @@ -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`. From 9061a9dfe6471c0bc6b07c17e4ce83544e7e4101 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 01:01:29 -0500 Subject: [PATCH 4/8] Point to plugin docs --- plugins/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/plugins/README.md b/plugins/README.md index 6651ba079f..48db29a70a 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -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 documention 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://https://backstage.io/plugins) to see other open source plugins to add to your instance. ## Suggesting a plugin From 6e7c9429ab39bcbb6741ec67207982f115c589a7 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 01:02:46 -0500 Subject: [PATCH 5/8] Clarify wording --- plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/README.md b/plugins/README.md index 48db29a70a..b281f33b37 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -6,7 +6,7 @@ For more information about the plugin ecosystem, see the documention here: > https://backstage.io/docs/plugins/ -You can also see the [Plugin Marketplace](https://https://backstage.io/plugins) to see other open source plugins to add to your instance. +You can also see the [Plugin Marketplace](https://https://backstage.io/plugins) for other open source plugins you can add to your Backstage instance. ## Suggesting a plugin From a7f8cbaed19b448939179e564c8191608f42e7f6 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 01:03:25 -0500 Subject: [PATCH 6/8] Fix test description typos --- .../src/scaffolder/stages/publish/helpers.test.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/publish/helpers.test.ts b/plugins/scaffolder-backend/src/scaffolder/stages/publish/helpers.test.ts index 3a317adacd..61d8e459bc 100644 --- a/plugins/scaffolder-backend/src/scaffolder/stages/publish/helpers.test.ts +++ b/plugins/scaffolder-backend/src/scaffolder/stages/publish/helpers.test.ts @@ -66,7 +66,7 @@ describe('pushToRemoteCred', () => { expect(mockIndex.writeTree).toHaveBeenCalled(); }); - it('should create a commit with on head with the right name and commiter', async () => { + it('should create a commit with on head with the right name and committer', async () => { const mockSignature = { mockSignature: 'bloblly' }; Signature.now.mockReturnValue(mockSignature); @@ -94,7 +94,7 @@ describe('pushToRemoteCred', () => { expect(Remote.create).toHaveBeenCalledWith(mockRepo, 'origin', 'mockclone'); }); - it('shoud push to the remote repo', async () => { + it('should push to the remote repo', async () => { await pushToRemoteCred(directory, remote, credentialsProvider); const [remotes, { callbacks }] = mockRemote.push.mock From 3440f9990b6fdf4a8217f27c9bbcfc22488251ca Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 01:11:23 -0500 Subject: [PATCH 7/8] Fix typo --- plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/README.md b/plugins/README.md index b281f33b37..b462dbf14f 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. This folder holds numerous plugins that are managed by this repository. -For more information about the plugin ecosystem, see the documention here: +For more information about the plugin ecosystem, see the documentation here: > https://backstage.io/docs/plugins/ From f7969caef7edbc2f833d569ab7c661820bd11eb3 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Tue, 29 Dec 2020 01:13:35 -0500 Subject: [PATCH 8/8] Fix link --- plugins/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/README.md b/plugins/README.md index b462dbf14f..385e71b6d2 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -6,7 +6,7 @@ For more information about the plugin ecosystem, see the documentation here: > https://backstage.io/docs/plugins/ -You can also see the [Plugin Marketplace](https://https://backstage.io/plugins) for other open source plugins you can add to your Backstage instance. +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