From f9b5866902880e644ea547a004146bb7a3a8f5a5 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Thu, 25 Jan 2024 22:38:21 +0530 Subject: [PATCH 1/6] some a11y fix Signed-off-by: npiyush97 --- docs/features/software-catalog/index.md | 14 ++++----- docs/overview/background.md | 2 +- docs/overview/what-is-backstage.md | 2 +- .../src/pages/plugins/plugins.module.scss | 3 +- microsite/src/theme/customTheme.scss | 31 +++++++++++++++++-- 5 files changed, 40 insertions(+), 12 deletions(-) diff --git a/docs/features/software-catalog/index.md b/docs/features/software-catalog/index.md index 0596d64ee4..ae3a4ef4c2 100644 --- a/docs/features/software-catalog/index.md +++ b/docs/features/software-catalog/index.md @@ -36,7 +36,7 @@ The Software Catalog is available to browse at `/catalog`. If you've followed [Getting Started with Backstage](../../getting-started), you should be able to browse the catalog at `http://localhost:3000`. -![](../../assets/software-catalog/software-catalog-home.png) +![screenshot of software catalog](../../assets/software-catalog/software-catalog-home.png) ## Adding components to the catalog @@ -55,7 +55,7 @@ There are 3 ways to add components to the catalog: Users can register new components by going to `/create` and clicking the **REGISTER EXISTING COMPONENT** button: -![](../../assets/software-catalog/bsc-register-1.png) +![screenshot of manually register existing component](../../assets/software-catalog/bsc-register-1.png) Backstage expects the full URL to the YAML in your source control. Example: @@ -66,7 +66,7 @@ https://github.com/backstage/backstage/blob/master/packages/catalog-model/exampl _More examples can be found [here](https://github.com/backstage/backstage/tree/master/packages/catalog-model/examples)._ -![](../../assets/software-catalog/bsc-register-2.png) +![screenshot of creating new components](../../assets/software-catalog/bsc-register-2.png) It is important to note that any kind of software can be registered in Backstage. Even if the software is not maintained by your company (SaaS @@ -100,7 +100,7 @@ More information about catalog configuration can be found Teams owning the components are responsible for maintaining the metadata about them, and do so using their normal Git workflow. -![](../../assets/software-catalog/bsc-edit.png) +![screenshot of updating component metadata](../../assets/software-catalog/bsc-edit.png) Once the change has been merged, Backstage will automatically show the updated metadata in the software catalog after a short while. @@ -112,14 +112,14 @@ in user. But you can also switch to _All_ to see all the components across your company's software ecosystem. Basic inline _search_ and _column filtering_ makes it easy to browse a big set of components. -![](../../assets/software-catalog/bsc-search.png) +![screenshot of finding software in the catalog](../../assets/software-catalog/bsc-search.png) ## Starring components For easy and quick access to components you visit frequently, Backstage supports _starring_ of components: -![](../../assets/software-catalog/bsc-starred.png) +![screenshot of starred components](../../assets/software-catalog/bsc-starred.png) ## Integrated tooling through plugins @@ -130,7 +130,7 @@ infrastructure UIs (and incurring additional cognitive overhead each time they make a context switch), most of these tools can be organized around the entities in the catalog. -![tools](https://backstage.io/assets/images/tabs-abfdf72185d3ceb1d92c4237f7f78809.png) +![screenshot of tools](https://backstage.io/assets/images/tabs-abfdf72185d3ceb1d92c4237f7f78809.png) The Backstage platform can be customized by incorporating [existing open source plugins](https://github.com/backstage/backstage/tree/master/plugins), diff --git a/docs/overview/background.md b/docs/overview/background.md index b74a2e0272..5e59967b21 100644 --- a/docs/overview/background.md +++ b/docs/overview/background.md @@ -35,4 +35,4 @@ Backstage was originally built by Spotify and then donated to the CNCF. Backstage is currently in the Incubation phase. Read the announcement [here](https://backstage.io/blog/2022/03/16/backstage-turns-two#out-of-the-sandbox-and-into-incubation). - +CNCF logo diff --git a/docs/overview/what-is-backstage.md b/docs/overview/what-is-backstage.md index f18993770a..e91b9774d7 100644 --- a/docs/overview/what-is-backstage.md +++ b/docs/overview/what-is-backstage.md @@ -40,7 +40,7 @@ Out of the box, Backstage includes: Backstage is a CNCF Incubation project after graduating from Sandbox. Read the announcement [here](https://backstage.io/blog/2022/03/16/backstage-turns-two#out-of-the-sandbox-and-into-incubation). - +CNCF logo ## Benefits diff --git a/microsite/src/pages/plugins/plugins.module.scss b/microsite/src/pages/plugins/plugins.module.scss index dbd0c62c75..30c4404fed 100644 --- a/microsite/src/pages/plugins/plugins.module.scss +++ b/microsite/src/pages/plugins/plugins.module.scss @@ -32,7 +32,8 @@ position: absolute; text-align: center; font-weight: bold; - + color: black; + transform: translateY(var(--translateY)) translateX(var(--translateX)) rotate(var(--rotation)); transform-origin: bottom left; diff --git a/microsite/src/theme/customTheme.scss b/microsite/src/theme/customTheme.scss index 57e1f8828e..4c71d43786 100644 --- a/microsite/src/theme/customTheme.scss +++ b/microsite/src/theme/customTheme.scss @@ -7,7 +7,7 @@ --ifm-color-primary-darker: #2e9e8a; --ifm-color-primary-darkest: #268271; } - +// for docs and releases #__docusaurus { .theme-doc-markdown { a { @@ -15,7 +15,34 @@ } } } - +// for blog +#__docusaurus { + .row { + .col { + &--7 { + a { + text-decoration: underline; + } + } + } + } +} +// for community page +#__docusaurus { + .communityPage_src-pages-demos-demos-module { + a:not([class]) { + text-decoration: underline; + } + } +} +// for plugin page +#__docusaurus { + .pluginsPage_src-pages-plugins-plugins-module { + a:not([class]) { + text-decoration: underline; + } + } +} .footerLogo { background-image: url(/img/logo.svg); background-repeat: no-repeat; From 49759eaab264613ffd8b679b3e98736dfabc95b1 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Thu, 25 Jan 2024 22:41:24 +0530 Subject: [PATCH 2/6] prettier Signed-off-by: npiyush97 --- microsite/src/pages/plugins/plugins.module.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsite/src/pages/plugins/plugins.module.scss b/microsite/src/pages/plugins/plugins.module.scss index 30c4404fed..fb17e90625 100644 --- a/microsite/src/pages/plugins/plugins.module.scss +++ b/microsite/src/pages/plugins/plugins.module.scss @@ -33,7 +33,7 @@ text-align: center; font-weight: bold; color: black; - + transform: translateY(var(--translateY)) translateX(var(--translateX)) rotate(var(--rotation)); transform-origin: bottom left; From 8823f7c1b5d64a2e6cc2ac998484e37679a4edd9 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Thu, 25 Jan 2024 23:00:13 +0530 Subject: [PATCH 3/6] forgot this bit Signed-off-by: npiyush97 --- microsite/src/theme/customTheme.scss | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/microsite/src/theme/customTheme.scss b/microsite/src/theme/customTheme.scss index 4c71d43786..f9b844d3dc 100644 --- a/microsite/src/theme/customTheme.scss +++ b/microsite/src/theme/customTheme.scss @@ -29,7 +29,8 @@ } // for community page #__docusaurus { - .communityPage_src-pages-demos-demos-module { + div[class^='communityPage'], + div[class*='communityPage'] { a:not([class]) { text-decoration: underline; } From 7f9c43dec12a80ecdf9d8816fd69f46c7014f2e3 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Thu, 25 Jan 2024 23:09:18 +0530 Subject: [PATCH 4/6] clean up Signed-off-by: npiyush97 --- microsite/src/theme/customTheme.scss | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/microsite/src/theme/customTheme.scss b/microsite/src/theme/customTheme.scss index f9b844d3dc..b29f76d3c0 100644 --- a/microsite/src/theme/customTheme.scss +++ b/microsite/src/theme/customTheme.scss @@ -38,7 +38,8 @@ } // for plugin page #__docusaurus { - .pluginsPage_src-pages-plugins-plugins-module { + div[class^='pluginsPage'], + div[class*='pluginsPage'] { a:not([class]) { text-decoration: underline; } From 81452d78e4cd87dcda77c4a98730ae8fc967f539 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Thu, 25 Jan 2024 23:15:15 +0530 Subject: [PATCH 5/6] hubspot color change Signed-off-by: npiyush97 --- microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss b/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss index 9533890660..20790c58f0 100644 --- a/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss +++ b/microsite/src/pages/home/hubSpotNewAdoptersForm.module.scss @@ -37,4 +37,10 @@ $page-header-height: 44px; padding-right: 2rem; } + select[class*='hs-input'] { + color: black; + } + input[class*='hs-button'] { + color: black; + } } From ad9768228d76beebce291b7ed7193e5dcb16e990 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Sun, 28 Jan 2024 18:27:44 +0530 Subject: [PATCH 6/6] ran lighthouse scripts over docs and releases find these Signed-off-by: npiyush97 --- docs/overview/logos.md | 28 ++++++++++++++-------------- docs/permissions/overview.md | 2 +- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/overview/logos.md b/docs/overview/logos.md index ac54640e33..fe993cc378 100644 --- a/docs/overview/logos.md +++ b/docs/overview/logos.md @@ -12,31 +12,31 @@ The assets below are all in `.svg` format. Other formats are available in the ## Backstage logo - - + + Backstage White logo - - + + Backstage Teal logo - - + + Backstage Black logo ## Backstage icon diff --git a/docs/permissions/overview.md b/docs/permissions/overview.md index 693f848c82..8630b85e23 100644 --- a/docs/permissions/overview.md +++ b/docs/permissions/overview.md @@ -22,7 +22,7 @@ The permission framework was designed with a few key properties in mind: - **Integrators** can author or configure policies that define which users can take certain actions upon which resources. -![](../assets/permissions/permission-framework-overview.drawio.svg) +![backstage framework overview](../assets/permissions/permission-framework-overview.drawio.svg) 1. The user triggers a request to perform some action. The request specifies the authorization details using the permission specified by the plugin (in this case, a resource read action).