diff --git a/docs/releases/v1.0.0.md b/docs/releases/v1.0.0.md new file mode 100644 index 0000000000..44a4f48213 --- /dev/null +++ b/docs/releases/v1.0.0.md @@ -0,0 +1,92 @@ +--- +id: v1.0.0 +title: 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 + +### 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 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: + +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. diff --git a/microsite/pages/en/index.js b/microsite/pages/en/index.js index 2f7c030c2a..19c0fe9986 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 + + ! diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 2a19c43ca3..f0f8811666 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -1,4 +1,7 @@ { + "releases": { + "Release Notes": ["releases/v1.0.0"] + }, "docs": { "Overview": [ "overview/what-is-backstage", diff --git a/microsite/siteConfig.js b/microsite/siteConfig.js index 30fec73832..6e291aa994 100644 --- a/microsite/siteConfig.js +++ b/microsite/siteConfig.js @@ -8,6 +8,23 @@ // 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,12 +62,13 @@ const siteConfig = { label: 'Blog', }, { - page: 'demos', - label: 'Demos', + doc: `releases/${latestRelease}`, + href: '/releases', + label: 'Releases', }, { - href: 'https://mailchi.mp/spotify/backstage-community', - label: 'Newsletter', + page: 'demos', + label: 'Demos', }, ], 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 {