From a26b7414866f1016d0b750532a5cb069ad61b850 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 2 Mar 2022 16:43:16 +0100 Subject: [PATCH 1/8] microsite: initial setup for release page Signed-off-by: Patrik Oldsberg --- docs/releases/overview.md | 7 +++++++ docs/releases/v1.0.0.md | 9 +++++++++ microsite/sidebars.json | 12 ++++++++++++ microsite/siteConfig.js | 5 +++++ 4 files changed, 33 insertions(+) create mode 100644 docs/releases/overview.md create mode 100644 docs/releases/v1.0.0.md diff --git a/docs/releases/overview.md b/docs/releases/overview.md new file mode 100644 index 0000000000..abc8d483e2 --- /dev/null +++ b/docs/releases/overview.md @@ -0,0 +1,7 @@ +--- +id: overview +title: Overview +description: Overview of the Backstage Releases +--- + +Things have been released! diff --git a/docs/releases/v1.0.0.md b/docs/releases/v1.0.0.md new file mode 100644 index 0000000000..66f86c9f3b --- /dev/null +++ b/docs/releases/v1.0.0.md @@ -0,0 +1,9 @@ +--- +id: v1.0.0 +title: v1.0.0 +description: Release v1.0.0 +--- + +## Highlights + +It's 1.0! diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 1d409ae051..02344ffb7a 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -1,4 +1,16 @@ { + "releases": { + "Releases": [ + "releases/overview", + { + "type": "subcategory", + "label": "Release Notes", + "ids": [ + "releases/v1.0.0" + ] + } + ] + }, "docs": { "Overview": [ "overview/what-is-backstage", diff --git a/microsite/siteConfig.js b/microsite/siteConfig.js index 30fec73832..c47536602c 100644 --- a/microsite/siteConfig.js +++ b/microsite/siteConfig.js @@ -44,6 +44,11 @@ const siteConfig = { blog: true, label: 'Blog', }, + { + doc: 'releases/overview', + href: '/releases', + label: 'Releases', + }, { page: 'demos', label: 'Demos', From 2a80a3e88b7e13ba46fa739a782be0dfd6b72421 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 14 Mar 2022 12:58:06 +0100 Subject: [PATCH 2/8] microsite: remove newsletter nav item Signed-off-by: Patrik Oldsberg --- microsite/siteConfig.js | 4 ---- 1 file changed, 4 deletions(-) diff --git a/microsite/siteConfig.js b/microsite/siteConfig.js index c47536602c..794349d815 100644 --- a/microsite/siteConfig.js +++ b/microsite/siteConfig.js @@ -53,10 +53,6 @@ const siteConfig = { page: 'demos', label: 'Demos', }, - { - href: 'https://mailchi.mp/spotify/backstage-community', - label: 'Newsletter', - }, ], /* path to images for header/footer */ From 658284411848eea5a7d379d70c383e15252d6cd3 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 14 Mar 2022 15:54:02 +0100 Subject: [PATCH 3/8] microsite: flatten release section Signed-off-by: Patrik Oldsberg --- docs/releases/overview.md | 7 ------- microsite/sidebars.json | 11 ++--------- microsite/siteConfig.js | 15 ++++++++++++++- 3 files changed, 16 insertions(+), 17 deletions(-) delete mode 100644 docs/releases/overview.md diff --git a/docs/releases/overview.md b/docs/releases/overview.md deleted file mode 100644 index abc8d483e2..0000000000 --- a/docs/releases/overview.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -id: overview -title: Overview -description: Overview of the Backstage Releases ---- - -Things have been released! diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 02344ffb7a..03cb2a965f 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -1,14 +1,7 @@ { "releases": { - "Releases": [ - "releases/overview", - { - "type": "subcategory", - "label": "Release Notes", - "ids": [ - "releases/v1.0.0" - ] - } + "Release Notes": [ + "releases/v1.0.0" ] }, "docs": { diff --git a/microsite/siteConfig.js b/microsite/siteConfig.js index 794349d815..2e440ff955 100644 --- a/microsite/siteConfig.js +++ b/microsite/siteConfig.js @@ -8,6 +8,19 @@ // See https://docusaurus.io/docs/site-config for all the possible // site configuration options. +// This figures out what the most recent release version is, so that we can link to it in the header +const [{name: latestRelease}] = require('fs').readdirSync(require('path').resolve(__dirname, '../docs/releases')).map(file => { + const match = file.match(/^v(\d+)\.(\d+)\.(\d+)\.md$/) + if (!match) { + return undefined + } + const parts = match.slice(1).map(v => parseInt(v, 10)) + return { + name: file.slice(0, file.length - '.md'.length), + weight: parts[0]*1000000 + parts[1]*1000 + parts[2], + } +}).filter(Boolean).sort((a, b) => b.weight - a.weight); + const siteConfig = { title: 'Backstage Software Catalog and Developer Platform', // Title for your website. tagline: 'An open platform for building developer portals', @@ -45,7 +58,7 @@ const siteConfig = { label: 'Blog', }, { - doc: 'releases/overview', + doc: `releases/${latestRelease}`, href: '/releases', label: 'Releases', }, From 0fc52fed39bf6f5e7b84e6f2debf51537067fe8d Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 15 Mar 2022 09:34:26 +0100 Subject: [PATCH 4/8] Run prettier Signed-off-by: blam --- microsite/sidebars.json | 4 +--- microsite/siteConfig.js | 26 +++++++++++++++----------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 03cb2a965f..8f8d180002 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -1,8 +1,6 @@ { "releases": { - "Release Notes": [ - "releases/v1.0.0" - ] + "Release Notes": ["releases/v1.0.0"] }, "docs": { "Overview": [ diff --git a/microsite/siteConfig.js b/microsite/siteConfig.js index 2e440ff955..6e291aa994 100644 --- a/microsite/siteConfig.js +++ b/microsite/siteConfig.js @@ -9,17 +9,21 @@ // site configuration options. // This figures out what the most recent release version is, so that we can link to it in the header -const [{name: latestRelease}] = require('fs').readdirSync(require('path').resolve(__dirname, '../docs/releases')).map(file => { - const match = file.match(/^v(\d+)\.(\d+)\.(\d+)\.md$/) - if (!match) { - return undefined - } - const parts = match.slice(1).map(v => parseInt(v, 10)) - return { - name: file.slice(0, file.length - '.md'.length), - weight: parts[0]*1000000 + parts[1]*1000 + parts[2], - } -}).filter(Boolean).sort((a, b) => b.weight - a.weight); +const [{ name: latestRelease }] = require('fs') + .readdirSync(require('path').resolve(__dirname, '../docs/releases')) + .map(file => { + const match = file.match(/^v(\d+)\.(\d+)\.(\d+)\.md$/); + if (!match) { + return undefined; + } + const parts = match.slice(1).map(v => parseInt(v, 10)); + return { + name: file.slice(0, file.length - '.md'.length), + weight: parts[0] * 1000000 + parts[1] * 1000 + parts[2], + }; + }) + .filter(Boolean) + .sort((a, b) => b.weight - a.weight); const siteConfig = { title: 'Backstage Software Catalog and Developer Platform', // Title for your website. From d3a85ab076dfbb796714cca4d89257291d26734b Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 15 Mar 2022 18:43:09 +0100 Subject: [PATCH 5/8] docs/releases: initial release notes for v1.0.0 Signed-off-by: Patrik Oldsberg --- docs/releases/v1.0.0.md | 83 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 81 insertions(+), 2 deletions(-) diff --git a/docs/releases/v1.0.0.md b/docs/releases/v1.0.0.md index 66f86c9f3b..ffd9b0fbdf 100644 --- a/docs/releases/v1.0.0.md +++ b/docs/releases/v1.0.0.md @@ -1,9 +1,88 @@ --- id: v1.0.0 title: v1.0.0 -description: Release v1.0.0 +description: Backstage Release v1.0.0 --- +These are the release notes for the v1.0.0 release of [Backstage](https://backstage.io/). + +A huge thanks to the whole team of maintainers and contributors as well as the amazing Backstage Community for the hard work in getting this release developed and done. + ## Highlights -It's 1.0! +### Packages Reaching 1.0 + +Several packages have reached version 1.0, you can read more about the effect of this in our [versioning policy](https://backstage.io/docs/overview/versioning-policy). + +#### Backstage Core + +- [`@backstage/app-defaults`](https://www.npmjs.com/package/@backstage/app-defaults) +- [`@backstage/config-loader`](https://www.npmjs.com/package/@backstage/config-loader) +- [`@backstage/config`](https://www.npmjs.com/package/@backstage/config) +- [`@backstage/core-app-api`](https://www.npmjs.com/package/@backstage/core-app-api) +- [`@backstage/core-plugin-api`](https://www.npmjs.com/package/@backstage/core-plugin-api) +- [`@backstage/dev-utils`](https://www.npmjs.com/package/@backstage/dev-utils) +- [`@backstage/errors`](https://www.npmjs.com/package/@backstage/errors) +- [`@backstage/integration-react`](https://www.npmjs.com/package/@backstage/integration-react) +- [`@backstage/integration`](https://www.npmjs.com/package/@backstage/integration) +- [`@backstage/test-utils`](https://www.npmjs.com/package/@backstage/test-utils) +- [`@backstage/types`](https://www.npmjs.com/package/@backstage/types) +- [`@backstage/version-bridge`](https://www.npmjs.com/package/@backstage/version-bridge) + +#### Software Catalog + +- [`@backstage/catalog-client`](https://www.npmjs.com/package/@backstage/catalog-client) +- [`@backstage/catalog-model`](https://www.npmjs.com/package/@backstage/catalog-model) +- [`@backstage/plugin-catalog-backend`](https://www.npmjs.com/package/@backstage/plugin-catalog-backend) +- [`@backstage/plugin-catalog-common`](https://www.npmjs.com/package/@backstage/plugin-catalog-common) +- [`@backstage/plugin-catalog-react`](https://www.npmjs.com/package/@backstage/plugin-catalog-react) +- [`@backstage/plugin-catalog`](https://www.npmjs.com/package/@backstage/plugin-catalog) + +#### Software Templates + +- [`@backstage/plugin-scaffolder-backend`](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend) +- [`@backstage/plugin-scaffolder-common`](https://www.npmjs.com/package/@backstage/plugin-scaffolder-common) +- [`@backstage/plugin-scaffolder`](https://www.npmjs.com/package/@backstage/plugin-scaffolder) + +#### TechDocs + +- [`@backstage/plugin-techdocs-backend`](https://www.npmjs.com/package/@backstage/plugin-techdocs-backend) +- [`@backstage/plugin-techdocs-node`](https://www.npmjs.com/package/@backstage/plugin-techdocs-node) +- [`@backstage/plugin-techdocs`](https://www.npmjs.com/package/@backstage/plugin-techdocs) +- [`@techdocs/cli`](https://www.npmjs.com/package/@techdocs/cli) + +### Switch from `@vscode/sqlite3` to `better-sqlite3` + +The default SQLite3 driver has been switched to [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3), as many users were running into issues with installation of `@vscode/sqlite3`. + +### New plugin: Google Calendar + +The new `@backstage/plugin-gcalendar` plugin by [@alexrybch](https://github.com/alexrybch) provides a home page widget that shows your Google Calendar events. + +### Package renames: + +The following packages have been renamed, be sure to update your usage: + +- `@backstage/search-common` -> `@backstage/plugin-search-common` +- `@backstage/techdocs-common` -> `@backstage/plugin-techdocs-node` + +## Security Fixes + +This release does not contain any security fixes. + +## Upgrade path + +We recommend that you keep your Backstage project up to date with this latest release. For more guidance on how to upgrade, check out the documentation for [keeping Backstage updated](https://backstage.io/docs/getting-started/keeping-backstage-updated). + +## Links and References + +Below you can find a list of links and references to help you learn about and start using this new release. + +- [Backstage official website](https://backstage.io/), [documentation](https://backstage.io/docs/), and [getting started guide](https://backstage.io/docs/getting-started/) +- [GitHub repository](https://github.com/backstage/backstage) +- Backstage's [versioning and support policy](https://backstage.io/docs/overview/versioning-policy) +- [Community Discord](https://discord.gg/bFESRKVt) for discussions and support +- [Changelog](https://github.com/backstage/backstage/releases/tag/v1.0.0) for this release +- Backstage [Demos](https://backstage.io/demos), [Blog](https://backstage.io/blog), [Roadmap](https://backstage.io/docs/overview/roadmap) and [Plugins](https://backstage.io/plugins) + +Sign up for our [newsletter](https://mailchi.mp/spotify/backstage-community) if you want to be informed about what is happening in the world of Backstage. From 5048bd85757585a53eb5043b75ee52963b50bee0 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 16 Mar 2022 10:41:12 +0100 Subject: [PATCH 6/8] microsite: shrink banner and provide padding for close button Signed-off-by: Patrik Oldsberg --- microsite/static/css/custom.css | 2 ++ 1 file changed, 2 insertions(+) diff --git a/microsite/static/css/custom.css b/microsite/static/css/custom.css index 139fa7b1d2..a7033e952b 100644 --- a/microsite/static/css/custom.css +++ b/microsite/static/css/custom.css @@ -1073,11 +1073,13 @@ code { .Banner { position: relative; padding: 14px; + padding-right: 50px; /* space for the dismiss button */ margin: 14px 20px; border-radius: 4px; background-color: $primaryColor; font-family: Helvetica Neue, sans-serif; color: #000; + display: inline-block; } .Banner--hidden { From bbb7932c1ac8cdc833cce1562d5ff2e9c0ad68a1 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 16 Mar 2022 10:41:32 +0100 Subject: [PATCH 7/8] microsite: move newsletter cta to dismissable banner Signed-off-by: Patrik Oldsberg --- microsite/pages/en/index.js | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/microsite/pages/en/index.js b/microsite/pages/en/index.js index 3804c45478..7bc14e7ec8 100644 --- a/microsite/pages/en/index.js +++ b/microsite/pages/en/index.js @@ -21,16 +21,12 @@ class Index extends React.Component { return (
- - 🚀 Feature updates!{' '} - - Software Templates - {' '} - and{' '} - - TechDocs - {' '} - are now in beta. + + 🗞️ Want to stay up to date with Backstage? Sign up for our{' '} + + Newsletter + + ! From 638cef0ae537171ac0cff38583e5880f57e99649 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 17 Mar 2022 10:39:14 +0100 Subject: [PATCH 8/8] docs/releases/v1.0.0: clearer attribution + scaffolder templates preview Signed-off-by: Patrik Oldsberg --- docs/releases/v1.0.0.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/releases/v1.0.0.md b/docs/releases/v1.0.0.md index ffd9b0fbdf..44a4f48213 100644 --- a/docs/releases/v1.0.0.md +++ b/docs/releases/v1.0.0.md @@ -57,7 +57,11 @@ The default SQLite3 driver has been switched to [better-sqlite3](https://github. ### New plugin: Google Calendar -The new `@backstage/plugin-gcalendar` plugin by [@alexrybch](https://github.com/alexrybch) provides a home page widget that shows your Google Calendar events. +The new `@backstage/plugin-gcalendar` plugin provides a home page widget that shows your Google Calendar events. Contributed by [@alexrybch](https://github.com/alexrybch) ([#9719](https://github.com/backstage/backstage/pull/9719)) + +### Scaffolder Template Preview + +The scaffolder page now provides a editor and preview page for templates, where you can see a live preview of the template form. The preview page can be found under the `/preview` sub route, typically at `/create/preview`. Contributed by [@kuangp](https://github.com/kuangp) ([#9841](https://github.com/backstage/backstage/pull/9841)) ### Package renames: