From 9394bd396b8303ab8cabe10b29e58f1613e11f9a Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 14:09:51 -0500 Subject: [PATCH 1/6] Capitalize Kubernetes and code fence plugin names Signed-off-by: Adam Harvey --- plugins/kubernetes-common/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/kubernetes-common/src/index.ts b/plugins/kubernetes-common/src/index.ts index af146ae9fa..6b97c0eb7d 100644 --- a/plugins/kubernetes-common/src/index.ts +++ b/plugins/kubernetes-common/src/index.ts @@ -15,7 +15,7 @@ */ /** - * Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin + * Common functionalities for Kubernetes, to be shared between the `kubernetes` and `kubernetes-backend` plugins * * @packageDocumentation */ From b804a9abb795fc888f48a3b5b9d27b32a0ec0636 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 14:10:15 -0500 Subject: [PATCH 2/6] Link to MUI theming Signed-off-by: Adam Harvey --- packages/theme/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/theme/src/index.ts b/packages/theme/src/index.ts index 93fec977f9..54ce880a71 100644 --- a/packages/theme/src/index.ts +++ b/packages/theme/src/index.ts @@ -15,7 +15,7 @@ */ /** - * material-ui theme for use with Backstage. + * {@link https://mui.com/customization/theming/ | material-ui theme} for use with Backstage. * * @packageDocumentation */ From 22bcaafa49539a9ba11858905ebf38a7e4dacc6c Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 14:10:35 -0500 Subject: [PATCH 3/6] Add packageDocumentation Signed-off-by: Adam Harvey --- plugins/sonarqube/src/index.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/plugins/sonarqube/src/index.ts b/plugins/sonarqube/src/index.ts index dcf0417151..1e6f83aa49 100644 --- a/plugins/sonarqube/src/index.ts +++ b/plugins/sonarqube/src/index.ts @@ -14,6 +14,13 @@ * limitations under the License. */ +/** + * A Backstage plugin to display {@link https://www.sonarqube.org | SonarQube} + * code quality and security results. + * + * @packageDocumentation + */ + export * from './components'; export { sonarQubePlugin, From a949ecfa8236d7f5e3411d1fb368b09eb638c4ce Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 14:17:49 -0500 Subject: [PATCH 4/6] Update API report Signed-off-by: Adam Harvey --- plugins/sonarqube/api-report.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/plugins/sonarqube/api-report.md b/plugins/sonarqube/api-report.md index 642e1d956f..b23ed65ddd 100644 --- a/plugins/sonarqube/api-report.md +++ b/plugins/sonarqube/api-report.md @@ -53,6 +53,4 @@ export { sonarQubePlugin }; // Warnings were encountered during analysis: // // src/components/SonarQubeCard/SonarQubeCard.d.ts:11:5 - (ae-forgotten-export) The symbol "DuplicationRating" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` From f3238cd9c82cd2562195fd4f4baa1b012a4f9fb2 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 19:03:38 -0500 Subject: [PATCH 5/6] Move MUI link to be more generic to avoid version specifics Signed-off-by: Adam Harvey --- packages/theme/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/theme/src/index.ts b/packages/theme/src/index.ts index 54ce880a71..41f827bf43 100644 --- a/packages/theme/src/index.ts +++ b/packages/theme/src/index.ts @@ -15,7 +15,7 @@ */ /** - * {@link https://mui.com/customization/theming/ | material-ui theme} for use with Backstage. + * {@link https://mui.com | material-ui} theme for use with Backstage * * @packageDocumentation */ From 59677fadb1d36002d7bc879cfe5b4cd20f1ee5f6 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 1 Dec 2021 19:06:48 -0500 Subject: [PATCH 6/6] Add changeset Signed-off-by: Adam Harvey --- .changeset/wild-flowers-taste.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .changeset/wild-flowers-taste.md diff --git a/.changeset/wild-flowers-taste.md b/.changeset/wild-flowers-taste.md new file mode 100644 index 0000000000..cf07237799 --- /dev/null +++ b/.changeset/wild-flowers-taste.md @@ -0,0 +1,7 @@ +--- +'@backstage/theme': patch +'@backstage/plugin-kubernetes-common': patch +'@backstage/plugin-sonarqube': patch +--- + +Improvements to API Reference documentation