From 0a80732c959c842a75dec563489c14b6fbc84fff Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Tue, 11 Jan 2022 12:45:03 +0100 Subject: [PATCH 01/24] Updated roadmap page in the public documentation Signed-off-by: Francesco Corti --- docs/overview/roadmap.md | 120 +++++++++++---------------------------- 1 file changed, 34 insertions(+), 86 deletions(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 4fde1662eb..7cd565c25e 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -7,10 +7,7 @@ description: Roadmap of Backstage ## The Backstage Roadmap Backstage is currently under rapid development. This page details the project’s -public roadmap, the result of ongoing collaboration between the core maintainers -and the broader Backstage community. Treat the roadmap as an ever-evolving guide -to keep us aligned as a community on: - +public roadmap, the result of ongoing collaboration between the core maintainers and the broader Backstage community. Treat the roadmap as an ever-evolving guide to keep us aligned as a community on: - Upcoming enhancements and benefits, - Planning contributions and support, - Planning the project’s adoption, @@ -28,20 +25,15 @@ already working) on a new or existing feature, please let us know, so that we can update the roadmap accordingly. We are also happy to share knowledge and context that will help your feature land successfully. -You can also head over to the -[CONTRIBUTING](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md) -guidelines to get started. +You can also head over to the [CONTRIBUTING](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md) guidelines to get started. -If you have specific questions about the roadmap, please create an -[issue](https://github.com/backstage/backstage/issues/new/choose), ping us on -[Discord](https://discord.gg/awD6SxgQ), or -[book time](http://calendly.com/spotify-backstage) with the Spotify team. +If you have specific questions about the roadmap, please create an [issue](https://github.com/backstage/backstage/issues/new/choose), ping us on [Discord](https://discord.gg/awD6SxgQ), or [book time](http://calendly.com/spotify-backstage) with the Spotify team. ### How to read the roadmap The Backstage roadmap lays out both [“what’s next”](#whats-next) and [“future work”](#future-work). With "next" we mean features planned for release -within the ongoing quarter starting in July until September 2021 included. With +within the ongoing quarter starting in January until March 2022 included. With "future" we mean features in the radar, but not yet scheduled. The long-term roadmap (12 - 36 months) is not detailed in the public roadmap. @@ -61,59 +53,19 @@ The feature set below is planned for the ongoing quarter, and grouped by theme. The list order doesn’t necessarily reflect priority, and the development/release cycle will vary based on maintainer schedules. -### Backstage Core +### Backstage 1.0 (and following versions) -The following features are planned for release: +During the first quarter of 2022 it is planned to be finalised and released the version 1.0 of the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). Included as part of this milestone: +- The cadence of minor/weekly/daily releases to provide clarity on the frequency and expectations for future versions of the platform and its defining modules. +- The support model to set the expectations from the adopters in their respective use cases. -- **Improved responsiveness:** Check out the - [RFC here](https://github.com/backstage/backstage/issues/6318) for further - details on how to improve the responsiveness for Backstage's UI. +### Backstage Security Audit -### Software Templates +This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third party companies in auditing the platform and highlighting potential vulnerabilities (if there are any). The benefit for the adopters is clear: we want Backstage to be as much secure as possible and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). -The following features are planned for release:: +### Moving to Incubation in CNCF -- **Re-creation/resubmission in case of failure:** Speed up productivity by - allowing developers to relaunch a project after a failure or any unexpected - problem. In the current version, this task requires retyping and a full - re-creation from scratch. -- **Performance and usability improvements for contributors:** Reach a relevant - improvement in templating's performance through the replacement of - [handlebars](https://handlebarsjs.com/). Other replacements will be considered - as part of this task (possibly - [cookiecutter](https://cookiecutter.readthedocs.io/)) for easier software - template creation, allowing more contributors to reach their goals without - having to learn new tooling. -- **Improved extensibility through inclusion:** Make software templates more - maintainable and extensible by adding `$include` support for parameters. -- **Authenticated job creation:** Created jobs will be able to run with an - authenticated user with all actions tracked for future consumption and - evidence. Track users creating jobs and make “jobs created by me” reporting - available. - -### Software Catalog - -The following features are planned for release: - -- **Request For Comments (RFC) for composability improvements (routing):** - Enable plugins to be auto-added and make plugin installation and upgrades - easier for all Backstage users. This includes information card layouts, entity - pages containing content and hooking the external header, considering the - support of a separate deployment, and configuration for plugins. -- **Removing duplicated entities in catalog:** As any adopter knows, a software - catalog can contain thousands or more entities and it is very important to - avoid duplications in naming to prevent failures. With this development task, - two entities with the same name won't be allowed as described - [here](https://github.com/backstage/backstage/issues/4760). -- **Connecting identity to ownership to prepare for role-based access control - ([RBAC](https://en.wikipedia.org/wiki/Role-based_access_control)):** This is a - first step to supporting RBAC for the software catalog (see the - [future work section](#future-work) for further details). Provide each entity - within the software catalog with a recognized owner. -- **Catalog performance improvements through improved caching:** Fix the - performance gaps in the catalog processor, which currently doesn’t have a - strong caching mechanism. The current version often requires fetching a - relevant amount of data, especially at scale. +The progress of the request can be seen [here](https://github.com/cncf/toc/pull/717). ## Future work @@ -121,32 +73,12 @@ The following feature list doesn’t represent a commitment to develop and the list order doesn’t reflect any priority or importance. But these features are on the maintainers’ radar, with clear interest expressed by the community. -- **Improved UX design:** Provide a better Backstage user experience through - visual guidelines and templates, especially navigation across plug-ins and - portal functionalities. -- **Catalog composability (routing):** Follow up development after the RFC - planned for the ongoing quarter (see [what’s next](#whats-next) for further - details). -- **Catalog-import improvements:** Provide a faster (scalability) and better - (more features like move/rename) way to import entities into the Software - Catalog. Importing items in the Software Catalog is crucial for creating a - Backstage proof-of-concept or testing/planning for broader organizational - adoption. This enhancement better supports getting developers to use Backstage - with less effort and customization. -- **Catalog improvements:** Add pagination and sourcing to Software Catalog. -- **[GraphQL](https://graphql.org/) support:** Introduce the ability to query - Backstage backend services with a standard query language for APIs. -- **Software templates performance improvements through decoupling a separate - worker:** Improve performance through decoupling resource-consuming services - and making them asynchronous. In the current version, project auto-creation - through the Software Templating system can consume a lot of resources and - bottleneck many concurrent projects created simultaneously. -- **API discovery and documentation:** Add better support for the - [gRPC](https://grpc.io/). -- **TechDocs GA release:** Work toward enhancements necessary to get TechDocs to - general availability. Check out the - [milestone here](https://github.com/backstage/backstage/milestone/30) for - further details. +- **Backend Services:** To better scale and maintain the Backstage instances, a backend layer of services is planned to be introduced as part of the software architecture. This layer of backend services will help in decoupling the various modules (Catalog and Scaffolder just to quote some) from the front-end experience. +- **Security Plan (and Strategy):** The purpose of the Security Strategy is to move another step ahead along the path of the maturity of the platform, setting the expectations of any adopters from a security point. +- **Search GA:**. +- **[GraphQL](https://graphql.org/) support:** Introduce the ability to query Backstage backend services with a standard query language for APIs. +- **Telemetry:** To efficiently collect, store and analyse system and application log data so that Backstage can be monitored and improved. +- **Improved UX design:** Provide a better Backstage user experience through visual guidelines and templates, especially navigation across plug-ins and portal functionalities. ## Completed milestones @@ -177,3 +109,19 @@ Read more about the completed (and released) features for reference. - Support auth providers: Google, Okta, GitHub, GitLab, [auth0](https://github.com/backstage/backstage/pull/1611), [AWS](https://github.com/backstage/backstage/pull/1990) + +- [Donate Backstage to the CNCF 🎉](https://backstage.io/blog/2020/09/23/backstage-cncf-sandbox) +- [TechDocs v1](https://backstage.io/blog/2020/09/08/announcing-tech-docs) +- [Plugin marketplace](https://backstage.io/plugins) +- [Improved and move documentation to backstage.io](https://backstage.io/docs/overview/what-is-backstage) +- [Backstage Software Catalog (alpha)](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha) +- [Backstage Software Templates (alpha)](https://backstage.io/blog/2020/08/05/announcing-backstage-software-templates) +- [Make it possible to add custom auth providers](https://backstage.io/blog/2020/07/01/how-to-enable-authentication-in-backstage-using-passport) +- [TechDocs v0](https://github.com/backstage/backstage/milestone/15) +- CI plugins: CircleCI, Jenkins, GitHub Actions and TravisCI +- [Service API documentation](https://github.com/backstage/backstage/pull/1737) +- Backstage Software Catalog can read from: GitHub, GitLab, + [Bitbucket](https://github.com/backstage/backstage/pull/1938) +- Support auth providers: Google, Okta, GitHub, GitLab, + [auth0](https://github.com/backstage/backstage/pull/1611), + [AWS](https://github.com/backstage/backstage/pull/1990) From 2a8d10dc9024a6353f6558f505821ed54b4fe1bb Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 11 Jan 2022 13:32:19 +0100 Subject: [PATCH 02/24] chore: fixing formatting for the roadmap Signed-off-by: blam --- docs/overview/roadmap.md | 59 +++++++++++++++++++++++++++++++--------- 1 file changed, 46 insertions(+), 13 deletions(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 7cd565c25e..d95db0aaa7 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -7,7 +7,10 @@ description: Roadmap of Backstage ## The Backstage Roadmap Backstage is currently under rapid development. This page details the project’s -public roadmap, the result of ongoing collaboration between the core maintainers and the broader Backstage community. Treat the roadmap as an ever-evolving guide to keep us aligned as a community on: +public roadmap, the result of ongoing collaboration between the core maintainers +and the broader Backstage community. Treat the roadmap as an ever-evolving guide +to keep us aligned as a community on: + - Upcoming enhancements and benefits, - Planning contributions and support, - Planning the project’s adoption, @@ -25,9 +28,14 @@ already working) on a new or existing feature, please let us know, so that we can update the roadmap accordingly. We are also happy to share knowledge and context that will help your feature land successfully. -You can also head over to the [CONTRIBUTING](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md) guidelines to get started. +You can also head over to the +[CONTRIBUTING](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md) +guidelines to get started. -If you have specific questions about the roadmap, please create an [issue](https://github.com/backstage/backstage/issues/new/choose), ping us on [Discord](https://discord.gg/awD6SxgQ), or [book time](http://calendly.com/spotify-backstage) with the Spotify team. +If you have specific questions about the roadmap, please create an +[issue](https://github.com/backstage/backstage/issues/new/choose), ping us on +[Discord](https://discord.gg/awD6SxgQ), or +[book time](http://calendly.com/spotify-backstage) with the Spotify team. ### How to read the roadmap @@ -55,17 +63,32 @@ cycle will vary based on maintainer schedules. ### Backstage 1.0 (and following versions) -During the first quarter of 2022 it is planned to be finalised and released the version 1.0 of the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). Included as part of this milestone: -- The cadence of minor/weekly/daily releases to provide clarity on the frequency and expectations for future versions of the platform and its defining modules. -- The support model to set the expectations from the adopters in their respective use cases. +During the first quarter of 2022 it is planned to be finalised and released the +version 1.0 of the Backstage platform (defined by the Core, +[Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), +[Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) +and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). +Included as part of this milestone: + +- The cadence of minor/weekly/daily releases to provide clarity on the frequency + and expectations for future versions of the platform and its defining modules. +- The support model to set the expectations from the adopters in their + respective use cases. ### Backstage Security Audit -This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third party companies in auditing the platform and highlighting potential vulnerabilities (if there are any). The benefit for the adopters is clear: we want Backstage to be as much secure as possible and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). +This initiative is the first of a broader Security Strategy for Backstage. The +purpose of the Security Audit is to involve third party companies in auditing +the platform and highlighting potential vulnerabilities (if there are any). The +benefit for the adopters is clear: we want Backstage to be as much secure as +possible and we want to make it reliable through a specific initiative. This +initiative in particular is done together (and with the support of) the +[Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). ### Moving to Incubation in CNCF -The progress of the request can be seen [here](https://github.com/cncf/toc/pull/717). +The progress of the request can be seen +[here](https://github.com/cncf/toc/pull/717). ## Future work @@ -73,12 +96,22 @@ The following feature list doesn’t represent a commitment to develop and the list order doesn’t reflect any priority or importance. But these features are on the maintainers’ radar, with clear interest expressed by the community. -- **Backend Services:** To better scale and maintain the Backstage instances, a backend layer of services is planned to be introduced as part of the software architecture. This layer of backend services will help in decoupling the various modules (Catalog and Scaffolder just to quote some) from the front-end experience. -- **Security Plan (and Strategy):** The purpose of the Security Strategy is to move another step ahead along the path of the maturity of the platform, setting the expectations of any adopters from a security point. +- **Backend Services:** To better scale and maintain the Backstage instances, a + backend layer of services is planned to be introduced as part of the software + architecture. This layer of backend services will help in decoupling the + various modules (Catalog and Scaffolder just to quote some) from the front-end + experience. +- **Security Plan (and Strategy):** The purpose of the Security Strategy is to + move another step ahead along the path of the maturity of the platform, + setting the expectations of any adopters from a security point. - **Search GA:**. -- **[GraphQL](https://graphql.org/) support:** Introduce the ability to query Backstage backend services with a standard query language for APIs. -- **Telemetry:** To efficiently collect, store and analyse system and application log data so that Backstage can be monitored and improved. -- **Improved UX design:** Provide a better Backstage user experience through visual guidelines and templates, especially navigation across plug-ins and portal functionalities. +- **[GraphQL](https://graphql.org/) support:** Introduce the ability to query + Backstage backend services with a standard query language for APIs. +- **Telemetry:** To efficiently collect, store and analyse system and + application log data so that Backstage can be monitored and improved. +- **Improved UX design:** Provide a better Backstage user experience through + visual guidelines and templates, especially navigation across plug-ins and + portal functionalities. ## Completed milestones From 063cbbef4785eb5b046a2512640dab1836008027 Mon Sep 17 00:00:00 2001 From: blam Date: Tue, 11 Jan 2022 13:36:57 +0100 Subject: [PATCH 03/24] chore: backtick the packages Signed-off-by: blam --- .changeset/dependabot-2af4c1d.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/dependabot-2af4c1d.md b/.changeset/dependabot-2af4c1d.md index 116df9ccd3..93dc1d1e21 100644 --- a/.changeset/dependabot-2af4c1d.md +++ b/.changeset/dependabot-2af4c1d.md @@ -3,4 +3,4 @@ '@backstage/plugin-ilert': patch --- -build(deps): bump @date-io/luxon from 1.3.13 to 2.11.1 \ No newline at end of file +build(deps): bump `@date-io/luxon` from 1.3.13 to 2.11.1 From ccd1c6617e7d5724db44168e02156d52697d0f41 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Tue, 11 Jan 2022 14:42:52 +0100 Subject: [PATCH 04/24] Update docs/overview/roadmap.md Co-authored-by: Ben Lambert --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index d95db0aaa7..870bbaeb73 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -148,7 +148,7 @@ Read more about the completed (and released) features for reference. - [Plugin marketplace](https://backstage.io/plugins) - [Improved and move documentation to backstage.io](https://backstage.io/docs/overview/what-is-backstage) - [Backstage Software Catalog (alpha)](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha) -- [Backstage Software Templates (alpha)](https://backstage.io/blog/2020/08/05/announcing-backstage-software-templates) +- [Backstage Software Templates (beta)](https://backstage.io/blog/2021/07/26/software-templates-are-now-in-beta) - [Make it possible to add custom auth providers](https://backstage.io/blog/2020/07/01/how-to-enable-authentication-in-backstage-using-passport) - [TechDocs v0](https://github.com/backstage/backstage/milestone/15) - CI plugins: CircleCI, Jenkins, GitHub Actions and TravisCI From c870703ee413c4b23ce2d33a9516b3e8e8ab41ec Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:32:25 +0100 Subject: [PATCH 05/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 870bbaeb73..bc7491a38c 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -41,7 +41,7 @@ If you have specific questions about the roadmap, please create an The Backstage roadmap lays out both [“what’s next”](#whats-next) and [“future work”](#future-work). With "next" we mean features planned for release -within the ongoing quarter starting in January until March 2022 included. With +within the ongoing quarter from January through March 2022. With "future" we mean features in the radar, but not yet scheduled. The long-term roadmap (12 - 36 months) is not detailed in the public roadmap. From f344a694a243751bb0235d78ab9a94cdc479be72 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:36:22 +0100 Subject: [PATCH 06/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index bc7491a38c..31d1b56c52 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -63,7 +63,7 @@ cycle will vary based on maintainer schedules. ### Backstage 1.0 (and following versions) -During the first quarter of 2022 it is planned to be finalised and released the +During the first quarter of 2022 we plan to be finalize and release version 1.0 of the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) From ebb0cddf07708a0be94b9efd5211450aa5ebe3d1 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:38:11 +0100 Subject: [PATCH 07/24] Typo in a change --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 31d1b56c52..e49afebefc 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -63,7 +63,7 @@ cycle will vary based on maintainer schedules. ### Backstage 1.0 (and following versions) -During the first quarter of 2022 we plan to be finalize and release +During the first quarter of 2022 we plan to finalize and release version 1.0 of the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) From 51a1946c2ccc676c688c95d0a917a0feffcc31fb Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:38:47 +0100 Subject: [PATCH 08/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Accepting the suggestion on the release cadence. Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index e49afebefc..850d7167a0 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -70,7 +70,7 @@ version 1.0 of the Backstage platform (defined by the Core, and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). Included as part of this milestone: -- The cadence of minor/weekly/daily releases to provide clarity on the frequency +- Deciding on the cadence of minor/weekly/daily releases to provide clarity on the frequency and expectations for future versions of the platform and its defining modules. - The support model to set the expectations from the adopters in their respective use cases. From 2059387e4a47129c9185bc7f63a1104389ffd871 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:39:07 +0100 Subject: [PATCH 09/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Accepting the suggestion on the support model. Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 850d7167a0..ceba282bf6 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -72,7 +72,7 @@ Included as part of this milestone: - Deciding on the cadence of minor/weekly/daily releases to provide clarity on the frequency and expectations for future versions of the platform and its defining modules. -- The support model to set the expectations from the adopters in their +- Establish the support model to set the expectations from the adopters in their respective use cases. ### Backstage Security Audit From 5d7d54438c3c18a894a2b09dc2270d52672f910f Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:39:31 +0100 Subject: [PATCH 10/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Typo in the benefits for adopters (Accepting the suggestion). Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index ceba282bf6..06e094416c 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -80,7 +80,7 @@ Included as part of this milestone: This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third party companies in auditing the platform and highlighting potential vulnerabilities (if there are any). The -benefit for the adopters is clear: we want Backstage to be as much secure as +benefit for the adopters is clear: we want Backstage to be as secure as possible and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). From 3d6041acf78ea318a50aa5cac989ce6ffee3b4bb Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:39:49 +0100 Subject: [PATCH 11/24] Update docs/overview/roadmap.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Accepting the suggestion on the security plan. Co-authored-by: Fredrik Adelöw --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 06e094416c..ceb10d3b9f 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -103,7 +103,7 @@ the maintainers’ radar, with clear interest expressed by the community. experience. - **Security Plan (and Strategy):** The purpose of the Security Strategy is to move another step ahead along the path of the maturity of the platform, - setting the expectations of any adopters from a security point. + setting the expectations of any adopters from a security standpoint. - **Search GA:**. - **[GraphQL](https://graphql.org/) support:** Introduce the ability to query Backstage backend services with a standard query language for APIs. From 7f280f3840f49da2769063874ac33795d26fd556 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Wed, 12 Jan 2022 09:41:22 +0100 Subject: [PATCH 12/24] Reviewing the telemetry description. Reviewing the telemetry description. --- docs/overview/roadmap.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index ceb10d3b9f..ad5e78bedb 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -107,8 +107,7 @@ the maintainers’ radar, with clear interest expressed by the community. - **Search GA:**. - **[GraphQL](https://graphql.org/) support:** Introduce the ability to query Backstage backend services with a standard query language for APIs. -- **Telemetry:** To efficiently collect, store and analyse system and - application log data so that Backstage can be monitored and improved. +- **Telemetry:** To efficiently generate logging and metrics in such a way that adopters can get insights so that Backstage can be monitored and improved. - **Improved UX design:** Provide a better Backstage user experience through visual guidelines and templates, especially navigation across plug-ins and portal functionalities. From ee45cd42d84246d00e01b3ac4ca694684a646041 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:15:45 +0100 Subject: [PATCH 13/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index ad5e78bedb..c35c4d9b3f 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -63,7 +63,7 @@ cycle will vary based on maintainer schedules. ### Backstage 1.0 (and following versions) -During the first quarter of 2022 we plan to finalize and release +During the first quarter of 2022, we plan to finalize and release version 1.0 of the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) From 796454994ba00b26db817989607051ce2a6f4edd Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:15:57 +0100 Subject: [PATCH 14/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index c35c4d9b3f..3b96111df3 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -78,7 +78,7 @@ Included as part of this milestone: ### Backstage Security Audit This initiative is the first of a broader Security Strategy for Backstage. The -purpose of the Security Audit is to involve third party companies in auditing +purpose of the Security Audit is to involve third-party companies in auditing the platform and highlighting potential vulnerabilities (if there are any). The benefit for the adopters is clear: we want Backstage to be as secure as possible and we want to make it reliable through a specific initiative. This From 4eff1188c0ec8fcab11f493aed97d9dd7488e517 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:16:32 +0100 Subject: [PATCH 15/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 3b96111df3..da1ff49bc9 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -79,7 +79,7 @@ Included as part of this milestone: This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third-party companies in auditing -the platform and highlighting potential vulnerabilities (if there are any). The +the platform and highlighting potential vulnerabilities. The benefit for the adopters is clear: we want Backstage to be as secure as possible and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the From 06860ac82826f46d52549d925ef37c0440ab8fcf Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:16:39 +0100 Subject: [PATCH 16/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index da1ff49bc9..ce80125a19 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -80,7 +80,7 @@ Included as part of this milestone: This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third-party companies in auditing the platform and highlighting potential vulnerabilities. The -benefit for the adopters is clear: we want Backstage to be as secure as +benefit for the adopters is clear: We want Backstage to be as secure as possible and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). From 5ed2ad9648edde6e6ada6e070f073a86f356f506 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:16:47 +0100 Subject: [PATCH 17/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index ce80125a19..6b54d3c13d 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -81,7 +81,7 @@ This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third-party companies in auditing the platform and highlighting potential vulnerabilities. The benefit for the adopters is clear: We want Backstage to be as secure as -possible and we want to make it reliable through a specific initiative. This +possible, and we want to make it reliable through a specific initiative. This initiative in particular is done together (and with the support of) the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). From af06098589fa89984bb2483fd5745c967553300a Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:16:59 +0100 Subject: [PATCH 18/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 6b54d3c13d..1125ae15ff 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -82,7 +82,7 @@ purpose of the Security Audit is to involve third-party companies in auditing the platform and highlighting potential vulnerabilities. The benefit for the adopters is clear: We want Backstage to be as secure as possible, and we want to make it reliable through a specific initiative. This -initiative in particular is done together (and with the support of) the +initiative in particular is done together, and with the support of, the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). ### Moving to Incubation in CNCF From cf77b60e0e6f27e94e4070a69766a1d6d096f117 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 10:17:07 +0100 Subject: [PATCH 19/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 1125ae15ff..aca775da82 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -92,7 +92,7 @@ The progress of the request can be seen ## Future work -The following feature list doesn’t represent a commitment to develop and the +The following feature list doesn’t represent a commitment to develop, and the list order doesn’t reflect any priority or importance. But these features are on the maintainers’ radar, with clear interest expressed by the community. From 5f0be90d88fbcf272d87670d4718903b921bc886 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 11:47:13 +0100 Subject: [PATCH 20/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index aca775da82..ebfe231a09 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -93,7 +93,7 @@ The progress of the request can be seen ## Future work The following feature list doesn’t represent a commitment to develop, and the -list order doesn’t reflect any priority or importance. But these features are on +list order doesn’t reflect any priority or importance, but these features are on the maintainers’ radar, with clear interest expressed by the community. - **Backend Services:** To better scale and maintain the Backstage instances, a From 22052dc872271e1796d972f06ccea9a3190782f0 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 11:47:26 +0100 Subject: [PATCH 21/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index ebfe231a09..50e954cace 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -99,7 +99,7 @@ the maintainers’ radar, with clear interest expressed by the community. - **Backend Services:** To better scale and maintain the Backstage instances, a backend layer of services is planned to be introduced as part of the software architecture. This layer of backend services will help in decoupling the - various modules (Catalog and Scaffolder just to quote some) from the front-end + various modules (e.g. Catalog and Scaffolder) from the frontend experience. - **Security Plan (and Strategy):** The purpose of the Security Strategy is to move another step ahead along the path of the maturity of the platform, From 6c16957065ee848854ddde6a87ba55e292d8165b Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 11:47:35 +0100 Subject: [PATCH 22/24] Update docs/overview/roadmap.md Review from rodmachen. Co-authored-by: Rod Machen --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 50e954cace..2dedad5de7 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -102,7 +102,7 @@ the maintainers’ radar, with clear interest expressed by the community. various modules (e.g. Catalog and Scaffolder) from the frontend experience. - **Security Plan (and Strategy):** The purpose of the Security Strategy is to - move another step ahead along the path of the maturity of the platform, + move another step along the path to maturing the platform, setting the expectations of any adopters from a security standpoint. - **Search GA:**. - **[GraphQL](https://graphql.org/) support:** Introduce the ability to query From ab61c4603a230c99632af4524ebc0f15d1739d35 Mon Sep 17 00:00:00 2001 From: Francesco Corti Date: Fri, 14 Jan 2022 12:30:14 +0100 Subject: [PATCH 23/24] Updated roadmap page in the public documentation. Signed-off-by: Francesco Corti --- docs/overview/roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 2dedad5de7..2eeaa00769 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -20,7 +20,7 @@ to keep us aligned as a community on: ### How to influence the roadmap As we evolve Backstage, we want you to contribute actively in the journey to -define the most effective developer experience in the world. +define the most effective developer experience in the world. A roadmap is only useful if it captures real needs. If you have success stories, feedback, or ideas, we want to hear from you! If you plan to work (or are From c8e0f906a137200650e55814c76055fb7df426e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 14 Jan 2022 13:19:11 +0100 Subject: [PATCH 24/24] prettier MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- docs/overview/roadmap.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md index 2eeaa00769..30338a6ee6 100644 --- a/docs/overview/roadmap.md +++ b/docs/overview/roadmap.md @@ -20,7 +20,7 @@ to keep us aligned as a community on: ### How to influence the roadmap As we evolve Backstage, we want you to contribute actively in the journey to -define the most effective developer experience in the world. +define the most effective developer experience in the world. A roadmap is only useful if it captures real needs. If you have success stories, feedback, or ideas, we want to hear from you! If you plan to work (or are @@ -41,8 +41,8 @@ If you have specific questions about the roadmap, please create an The Backstage roadmap lays out both [“what’s next”](#whats-next) and [“future work”](#future-work). With "next" we mean features planned for release -within the ongoing quarter from January through March 2022. With -"future" we mean features in the radar, but not yet scheduled. +within the ongoing quarter from January through March 2022. With "future" we +mean features in the radar, but not yet scheduled. The long-term roadmap (12 - 36 months) is not detailed in the public roadmap. Third-party contributions are also not currently included in the roadmap. Let us @@ -63,15 +63,16 @@ cycle will vary based on maintainer schedules. ### Backstage 1.0 (and following versions) -During the first quarter of 2022, we plan to finalize and release -version 1.0 of the Backstage platform (defined by the Core, +During the first quarter of 2022, we plan to finalize and release version 1.0 of +the Backstage platform (defined by the Core, [Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview), [Scaffolder](https://backstage.io/docs/features/software-templates/software-templates-index) and [TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview)). Included as part of this milestone: -- Deciding on the cadence of minor/weekly/daily releases to provide clarity on the frequency - and expectations for future versions of the platform and its defining modules. +- Deciding on the cadence of minor/weekly/daily releases to provide clarity on + the frequency and expectations for future versions of the platform and its + defining modules. - Establish the support model to set the expectations from the adopters in their respective use cases. @@ -79,10 +80,10 @@ Included as part of this milestone: This initiative is the first of a broader Security Strategy for Backstage. The purpose of the Security Audit is to involve third-party companies in auditing -the platform and highlighting potential vulnerabilities. The -benefit for the adopters is clear: We want Backstage to be as secure as -possible, and we want to make it reliable through a specific initiative. This -initiative in particular is done together, and with the support of, the +the platform and highlighting potential vulnerabilities. The benefit for the +adopters is clear: We want Backstage to be as secure as possible, and we want to +make it reliable through a specific initiative. This initiative in particular is +done together, and with the support of, the [Cloud Native Computing Foundation (CNCF)](https://www.cncf.io/). ### Moving to Incubation in CNCF @@ -99,15 +100,15 @@ the maintainers’ radar, with clear interest expressed by the community. - **Backend Services:** To better scale and maintain the Backstage instances, a backend layer of services is planned to be introduced as part of the software architecture. This layer of backend services will help in decoupling the - various modules (e.g. Catalog and Scaffolder) from the frontend - experience. + various modules (e.g. Catalog and Scaffolder) from the frontend experience. - **Security Plan (and Strategy):** The purpose of the Security Strategy is to - move another step along the path to maturing the platform, - setting the expectations of any adopters from a security standpoint. + move another step along the path to maturing the platform, setting the + expectations of any adopters from a security standpoint. - **Search GA:**. - **[GraphQL](https://graphql.org/) support:** Introduce the ability to query Backstage backend services with a standard query language for APIs. -- **Telemetry:** To efficiently generate logging and metrics in such a way that adopters can get insights so that Backstage can be monitored and improved. +- **Telemetry:** To efficiently generate logging and metrics in such a way that + adopters can get insights so that Backstage can be monitored and improved. - **Improved UX design:** Provide a better Backstage user experience through visual guidelines and templates, especially navigation across plug-ins and portal functionalities.