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

Merge pull request #15200 from backstage/jhaals/next-docs

Browse Source 
microsite-next: serve docs from docs folder
This commit is contained in:
Johan Haals
2022-12-13 15:06:27 +01:00
committed by GitHub
parent 8a9206ed33 5b08ea6913
commit ff7d67eebb
13 changed files with 75 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/utility-apis.md
+7 -7
View File
@@ -283,14 +283,14 @@ long as they adhere to the contract established by an
implementation they want.
The figure below shows the relationship between
<span style="color: #82b366">different Apps</span>, that provide
<span style="color: #6c8ebf">different implementations</span> of the
<span style="color: #9673a6">FooApi</span>.
<span style="color: #d6b656">Components</span> within Plugins then access the
<span style="color: #9673a6">FooApi</span> via the
<span style="color: #b85450">fooApiRef</span>.
<span class="textGreen" className="textGreen">different Apps</span>, that provide
<span class="textBlue" className="textBlue"> different implementations</span> of the
<span class="textPurple" className="textPurple"> FooApi</span>.
<span class="textYellow" className="textYellow"> Components</span> within Plugins then access the
<span class="textPurple" className="textPurple"> FooApi</span> via the
<span class="textRed" className="textRed"> fooApiRef</span>.
<div style="text-align:center">
<div className="textAlignCenter" class="textAlignCenter">
<img src="../assets/utility-apis-fig1.svg" alt="Figure showing the relationship between utility APIs, the apps that provide them, and the plugins that consume them" />
</div>
docs/features/search/how-to-guides.md
+3 -3
View File
@@ -1,8 +1,8 @@
---
id: how-to-guides
title: Search "HOW TO" guides
sidebar_label: "HOW TO" guides
description: Search "HOW TO" guides
title: Search How-To guides
sidebar_label: How-To guides
description: Search How To guides
---
## How to implement your own Search API
docs/features/techdocs/how-to-guides.md
+3 -3
View File
@@ -1,8 +1,8 @@
---
id: how-to-guides
title: TechDocs "HOW TO" guides
sidebar_label: "HOW TO" guides
description: TechDocs "HOW TO" guides related to TechDocs
title: TechDocs How-To guides
sidebar_label: How-To guides
description: TechDocs How-To guides related to TechDocs
---
## How to migrate from TechDocs Basic to Recommended deployment approach?
docs/getting-started/homepage.md
+2 -2
View File
@@ -84,8 +84,8 @@ Let's update the route for "Home" in the Backstage sidebar to point to the new h
<table>
<tr>
<th><img data-zoomable src="../assets/getting-started/sidebar-without-catalog.png" alt="Sidebar without Catalog" /></td>
<th><img data-zoomable src="../assets/getting-started/sidebar-with-catalog.png" alt="Sidebar with Catalog" /></td>
<th><img data-zoomable src="../assets/getting-started/sidebar-without-catalog.png" alt="Sidebar without Catalog" /></th>
<th><img data-zoomable src="../assets/getting-started/sidebar-with-catalog.png" alt="Sidebar with Catalog" /></th>
</tr>
<tr align="center">
<td>Before</td>
docs/overview/logos.md
+2 -2
View File
@@ -21,7 +21,7 @@ The assets below are all in `.svg` format. Other formats are available in the
</a>
<a href="https://backstage.io/logo_assets/svg/Logo_Black.svg">
<img src="https://backstage.io/logo_assets/svg/Logo_Black.svg" width="600" style="background-color:white" />
<img src="https://backstage.io/logo_assets/svg/Logo_Black.svg" width="600" className="logoWhite" class="logoWhite" />
</a>
## Backstage icon
@@ -37,6 +37,6 @@ The assets below are all in `.svg` format. Other formats are available in the
<img src="https://backstage.io/logo_assets/svg/Icon_Gradient.svg" width="180" height="180" />
</a>
<a href="https://backstage.io/logo_assets/svg/Icon_Black.svg">
<img src="https://backstage.io/logo_assets/svg/Icon_Black.svg" width="180" height="180" style="background-color:white" />
<img src="https://backstage.io/logo_assets/svg/Icon_Black.svg" width="180" height="180" className="logoWhite" class="logoWhite" />
</a>
</div>
docs/overview/versioning-policy.md
+1 -1
View File
@@ -1,7 +1,7 @@
---
id: versioning-policy
title: Release & Versioning Policy
description:
description: The process and policy for releasing and versioning Backstage
---
The Backstage project is comprised of a set of software components that together
docs/releases/v1.2.0-changelog.md
+2 -2
View File
@@ -722,7 +722,7 @@
### Patch Changes
- ac19f82936: Added ARIA landmark <main> to Page component and added ARIA landmark <nav> to DesktopSidebar and Sidebar components
- ac19f82936: Added ARIA landmark `<main>` to Page component and added ARIA landmark `<nav>` to DesktopSidebar and Sidebar components
- 55f68c386a: Enabled select component to be enabled by keyboard
- c0055ece91: Announce external links to screen readers
- e210c0cab8: Add ability to customize `Read More` destination with `readMoreUrl` prop for `MissingAnnotationEmptyState` component.
@@ -733,7 +733,7 @@
- e462112be5: Updated dependency `rc-progress` to `3.3.2`.
- 2bcb0a0e2b: Sidebar NAV now includes aria-label. Component AboutField now uses h2 variant instead of subtitle2 (font properties unchanged)
- c7f32b53a4: Fixed multiple scrolls appearing on Page when added InfoCard with external bottom link
- 3603014e0e: Add ARIA landmark( <main>), & label and a heading to OAuthRequestDialog. Removed nested interactive control (button).
- 3603014e0e: Add ARIA landmark( `<main>`), & label and a heading to OAuthRequestDialog. Removed nested interactive control (button).
- 2025d7c123: Properly highlight `SidebarSubmenuItem` dropdown items on hover, use ellipsis styling on long labels in `SidebarSubmenu`, allow `icon` and `to` properties to be optional on `SidebarSubmenuItem`, and fix `SidebarPage` padding to be responsive to pinned state
- 2295b4ab2b: Add controls to Storybook stories
- 521293b22e: Added a chevron Indicator when the sidebar is collapsed and has a sub-menu
docs/releases/v1.2.0-next.1-changelog.md
+1 -1
View File
@@ -169,7 +169,7 @@
### Patch Changes
- ac19f82936: Added ARIA landmark <main> to Page component and added ARIA landmark <nav> to DesktopSidebar and Sidebar components
- ac19f82936: Added ARIA landmark `<main>` to Page component and added ARIA landmark `<nav>` to DesktopSidebar and Sidebar components
- c0055ece91: Announce external links to screen readers
- cfc0f2e5bd: Added optional anchorOrigin alignment prop to AlertDisplay
- f4380eb602: Add an aria-label to the support button to improve accessibility for screen readers
docs/releases/v1.2.0-next.3-changelog.md
+1 -1
View File
@@ -5,7 +5,7 @@
### Patch Changes
- 52c02ac02b: Don't set the background color on an Avatar component that has a picture.
- 3603014e0e: Add ARIA landmark( <main>), & label and a heading to OAuthRequestDialog. Removed nested interactive control (button).
- 3603014e0e: Add ARIA landmark( `<main>`), & label and a heading to OAuthRequestDialog. Removed nested interactive control (button).
- 2025d7c123: Properly highlight `SidebarSubmenuItem` dropdown items on hover, use ellipsis styling on long labels in `SidebarSubmenu`, allow `icon` and `to` properties to be optional on `SidebarSubmenuItem`, and fix `SidebarPage` padding to be responsive to pinned state
## @backstage/plugin-home@0.4.21-next.3
microsite-next/docs/init.md
-8
View File
@@ -1,8 +0,0 @@
---
id: init
title: Init
# prettier-ignore
description: This will be replaced by the docs
---
TBD
microsite-next/docusaurus.config.js
+1 -1
View File
@@ -45,7 +45,7 @@ module.exports = {
showLastUpdateAuthor: true,
showLastUpdateTime: true,
editUrl: 'https://github.com/backstage/backstage/edit/master/docs/',
path: 'docs',
path: '../docs',
sidebarPath: 'sidebars.json',
},
blog: {
microsite-next/src/css/customTheme.css
+26
View File
@@ -19,3 +19,29 @@
.copyright {
font-size: 10pt;
}
/* logo.md */
.logoWhite {
background-color: white;
}
/* Utility API Styling */
.textGreen {
color: #82b366;
}
.textBlue {
color: #6c8ebf;
}
.textPurple {
color: #9673a6;
}
.textYellow {
color: #d6b656;
}
.textRed {
color: #b85450;
}
.textAlignCenter {
text-align: center;
}
/* End of Utility API Styling */
microsite/static/css/custom.css
+26
View File
@@ -1294,3 +1294,29 @@ h3.collapsible span.arrow {
#Sidebar__HubSpotContainer.submitted-message p {
color: rgb(0, 0, 0);
}
/* logo.md */
.logoWhite {
background-color: white;
}
/* Utility API Styling */
.textGreen {
color: #82b366;
}
.textBlue {
color: #6c8ebf;
}
.textPurple {
color: #9673a6;
}
.textYellow {
color: #d6b656;
}
.textRed {
color: #b85450;
}
.textAlignCenter {
text-align: center;
}
/* End of Utility API Styling */