diff --git a/README.md b/README.md
index 9a1622cda7..ee9e85fd7f 100644
--- a/README.md
+++ b/README.md
@@ -18,26 +18,16 @@ Backstage unifies all your infrastructure tooling, services, and documentation t
Out of the box, Backstage includes:
-- [Backstage Service Catalog](https://github.com/spotify/backstage/blob/master/docs/features/software-catalog/index.md) for managing all your software (microservices, libraries, data pipelines, websites, ML models, etc.)
-- [Backstage Software Templates](https://github.com/spotify/backstage/blob/master/docs/features/software-templates/index.md) for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
-- [Backstage TechDocs](https://github.com/spotify/backstage/tree/master/docs/features/techdocs) for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
+- [Backstage Service Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview) for managing all your software (microservices, libraries, data pipelines, websites, ML models, etc.)
+- [Backstage Software Templates](https://backstage.io/docs/features/software-templates/software-templates-index) for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
+- [Backstage TechDocs](https://backstage.io/docs/features/techdocs/techdocs-overview) for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
- Plus, a growing ecosystem of [open source plugins](https://github.com/spotify/backstage/tree/master/plugins) that further expand Backstage’s customizability and functionality
For more information go to [backstage.io](https://backstage.io) or join our [Discord chatroom](https://discord.gg/EBHEGzX).
## Project roadmap
-We created Backstage about 4 years ago. While our internal version of Backstage has had the benefit of time to mature and evolve, the first iteration of our open source version is still nascent. We are envisioning three phases of the project and we have already begun work on various aspects of these phases:
-
-- 🐣 **Phase 1:** Extensible frontend platform (Done ✅) - You will be able to easily create a single consistent UI layer for your internal infrastructure and tools. A set of reusable [UX patterns and components](http://backstage.io/storybook) help ensure a consistent experience between tools.
-
-- 🐢 **Phase 2:** Service Catalog ([alpha released](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha)) - With a single catalog, Backstage makes it easy for a team to manage ten services — and makes it possible for your company to manage thousands of them. Developers can get a uniform overview of all their software and related resources, regardless of how and where they are running, as well as an easy way to onboard and manage those resources.
-
-- 🐇 **Phase 3:** Ecosystem (later) - Everyone's infrastructure stack is different. By fostering a vibrant community of contributors we hope to provide an ecosystem of Open Source plugins/integrations that allows you to pick the tools that match your stack.
-
-Check out our [Milestones](https://github.com/spotify/backstage/milestones) and open [RFCs](https://github.com/spotify/backstage/labels/rfc) how they relate to the three Phases outlined above.
-
-Our vision for Backstage is for it to become the trusted standard toolbox (read: UX layer) for the open source infrastructure landscape. Think of it like Kubernetes for developer experience. We realize this is an ambitious goal. We can’t do it alone. If this sounds interesting or you'd like to help us shape our product vision, we'd love to talk. You can email me directly: [alund@spotify.com](mailto:alund@spotify.com).
+A detailed project roadmap, including already delivered milestones, is available [here](https://backstage.io/docs/overview/roadmap).
## Overview
@@ -69,7 +59,7 @@ Using `npx` you can then run the following to create an app in a chosen subdirec
npx @backstage/create-app
```
-You will be taken through a wizard to create your app, and the output should look something like this. You can read more about this process [here](docs/getting-started/create-an-app.md)
+You will be taken through a wizard to create your app, and the output should look something like this. You can read more about this process [here](https://backstage.io/docs/getting-started/create-an-app)
### Contributing to Backstage
@@ -77,22 +67,22 @@ You can read more in our [CONTRIBUTING.md](./CONTRIBUTING.md#get-started) guide,
### Next steps
-Take a look at the [Getting Started](docs/getting-started/index.md) guide to learn how to set up Backstage, and how to develop on the platform.
+Take a look at the [Getting Started](https://backstage.io/docs/getting-started/index) guide to learn how to set up Backstage, and how to develop on the platform.
## Documentation
-- [Main documentation](docs/README.md)
-- [Service Catalog](docs/features/software-catalog/index.md)
-- [Architecture](docs/overview/architecture-terminology.md) ([Decisions](docs/architecture-decisions/index.md))
-- [Designing for Backstage](docs/dls/design.md)
-- [Storybook - UI components](http://backstage.io/storybook)
+- [Main documentation](https://backstage.io/docs/overview/what-is-backstage)
+- [Service Catalog](https://backstage.io/docs/features/software-catalog/software-catalog-overview)
+- [Architecture](https://backstage.io/docs/overview/architecture-terminology) ([Decisions](https://backstage.io/docs/architecture-decisions/adrs-overview))
+- [Designing for Backstage](https://backstage.io/docs/dls/design)
+- [Storybook - UI components](https://backstage.io/storybook)
## Community
- [Discord chatroom](https://discord.gg/MUpMjP2) - Get support or discuss the project
- [Good First Issues](https://github.com/spotify/backstage/contribute) - Start here if you want to contribute
- [RFCs](https://github.com/spotify/backstage/labels/rfc) - Help shape the technical direction
-- [FAQ](docs/FAQ.md) - Frequently Asked Questions
+- [FAQ](https://backstage.io/docs/FAQ) - Frequently Asked Questions
- [Code of Conduct](CODE_OF_CONDUCT.md) - This is how we roll
- [Adopters](ADOPTERS.md) - Companies already using Backstage
- [Blog](https://backstage.io/blog/) - Announcements and updates
diff --git a/docs/README.md b/docs/README.md
index 9bbc69ca6d..b9e79a9e0a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -11,6 +11,7 @@ better yet, a pull request.
- [Backstage architecture](overview/architecture-overview.md)
- [Architecture and terminology](overview/architecture-terminology.md)
- [Roadmap](overview/roadmap.md)
+ - [Vision](overview/vision.md)
- Getting started
- [Running Backstage locally](getting-started/index.md)
- [Installation](getting-started/installation.md)
diff --git a/docs/auth/auth-backend-classes.md b/docs/auth/auth-backend-classes.md
index 1a476fa2f0..42ee48c5e0 100644
--- a/docs/auth/auth-backend-classes.md
+++ b/docs/auth/auth-backend-classes.md
@@ -1,11 +1,11 @@
-# Authentication backend class layout and description.
+# Authentication Backend Classes Layout and Description
-## How does authentication work ?
+## How Does Authentication Work?
-The Backstage application can use various authentication `providers` for
-authentication. A provider has to implement an `AuthProviderRouterHandlers`
-interface for handling authentication. This interface consists of 4 methods.
-Each of this method is hosted at an endpoint `/auth/[provider]/method`, where
+The Backstage application can use various authentication providers for
+authentication. A provider has to implement an `AuthProviderRouteHandlers`
+interface for handling authentication. This interface consists of four methods.
+Each of these methods is hosted at an endpoint `/auth/[provider]/method`, where
`method` performs a certain operation as follows:
```
@@ -16,44 +16,45 @@ Each of this method is hosted at an endpoint `/auth/[provider]/method`, where
```
For more information on how these methods are used and for which purpose, refer
-to the documentation [here](oauth.md)
+to the documentation [here](oauth.md).
For details on the parameters, input and output conditions for each method,
refer to the type documentation under
-`backstage/plugins/auth-backend/src/providers/types.ts`
+`plugins/auth-backend/src/providers/types.ts`.
-There are currently 2 different classes for 2 authentication mechanisms that
-implement this interface: `OAuthProvider` for `OAuth` based Mechanism and a
-`SAMLAuthProvider` for a `SAML` based mechanism
+There are currently two different classes for two authentication mechanisms that
+implement this interface: an `OAuthProvider` for [OAuth](https://oauth.net/2/)
+based mechanisms and a `SAMLAuthProvider` for
+[SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html)
+based mechanisms.
-### `OAuth` mechanisms
+### OAuth mechanisms
-Currently `OAuth` is assumed to be the defacto authentication mechanism for
-backstage based applications.
+Currently OAuth is assumed to be the de facto authentication mechanism for
+Backstage based applications.
-Backstage comes with `batteries-included` set of OAuth Providers for some
-commonly used Providers : `Okta`, `Github`, `Google` , `Gitlab` and a generic
-`oauth2` provider.
+Backstage comes with a "batteries-included" set of supported commonly used OAuth
+providers: Okta, Github, Google, Gitlab, and a generic OAuth2 provider.
-All of these use the `authorization` flow of OAuth2 to implement authentication.
+All of these use the authorization flow of OAuth2 to implement authentication.
-If your `authentication` provider is any of the above mentioned (except
-`oauth2`) providers, you can configure them by setting the right variables in
-`app-config.yaml` under then `auth` section.
+If your authentication provider is any of the above mentioned (except generic
+OAuth2) providers, you can configure them by setting the right variables in
+`app-config.yaml` under the `auth` section.
### Configuration
-Each authentication (except SAML )provider needs 5 parameters: an `oauth`
-client_id, client_secret, an authorization endpoint and a token endpoint, and an
-app origin. The `appOrigin` value is the URL at which the frontend of the
-application is hosted. This is required because, the application opens a popup
-window to perform the authentication and once the flow is completed, the popup
+Each authentication provider (except SAML) needs five parameters: an OAuth
+client ID, a client secret, an authorization endpoint and a token endpoint, and
+an app origin. The app origin is the URL at which the frontend of the
+application is hosted. This is required because the application opens a popup
+window to perform the authentication, and once the flow is completed, the popup
window sends a `postMessage` to the frontend application to indicate the result
of the operation. Also this URL is used to verify that authentication requests
are coming from only this endpoint.
These values are configured via the `app-config.yaml` present in the root of
-your app folder
+your app folder.
```
auth:
@@ -87,36 +88,37 @@ auth:
secure: false
clientId:
$secret:
+ ...
```
-## Technical notes
+## Technical Notes
### EnvironmentHandler
-The concept of an `env` is core to the way the `auth-backend` works. `Spotify`
-uses an `env` query parameter to identify the environment in which the
-application is running (`dev`, `staging`, `prod`, etc). Each runtime can support
+The concept of an "env" is core to the way the auth backend works. It uses an
+`env` query parameter to identify the environment in which the application is
+running (`development`, `staging`, `production`, etc). Each runtime can support
multiple environments at the same time and the right handler for each request is
identified and dispatched to based on the `env` parameter. All
-`AuthProviderRouterHandlers` are wrapped within a `EnvironmentHandler`.
+`AuthProviderRouteHandlers` are wrapped within an `EnvironmentHandler`.
-An `EnvironmentHandler` takes an `id` for each provider that it wraps, the
-handlers for each of the `env` the provider is supported in, and a `function`
-that given a `Request` as argument, can extract the information about the `env`
-under which it should be processed.
+An `EnvironmentHandler` takes an ID for each provider that it wraps, the
+handlers for each env the provider is supported in, and a function that, given a
+`Request` as argument, can extract the information about the env under which it
+should be processed.
-Each provider exposes a factory function `createXProvider` (where X = name of
-the Provider) that takes the globalconfig, env and other parameters and returns
-a `AuthProviderRouteHandler` for each env, AND, a `envIdentifier` fn to identify
-the `env` in a request.
+Each provider exposes a factory function `createXProvider` (where X is the name
+of the provider) that takes the global config, env and other parameters and
+returns an `AuthProviderRouteHandlers` for each env, and an `envIdentifier`
+function to identify the env of a request.
For a list of currently available providers, look in the `factories` module
-located in `backstage/plugins/auth-backend/src/providers/factories.ts`
+located in `plugins/auth-backend/src/providers/factories.ts`
-### `oauth2` provider
+### OAuth2 provider
-The `oauth2` provider abstracts a generic **OAuth2+OIDC** based authentication
+The `oauth2` provider abstracts a generic **OAuth2 + OIDC** based authentication
provider. What this means is that after the application has been given
-permission by the user, the`authorization code` will be exchanged for an
-`access_token` , a `refresh_token` and an `id_token`. This `id_token` is used to
+permission by the user, the `authorization code` will be exchanged for an
+`access_token`, a `refresh_token` and an `id_token`. This `id_token` is used to
obtain an email id of the user, which is then used for creating the session.
diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md
index 4751bd88f7..a7d57890dc 100644
--- a/docs/features/software-catalog/descriptor-format.md
+++ b/docs/features/software-catalog/descriptor-format.md
@@ -42,6 +42,7 @@ software catalog API.
"labels": {
"system": "public-websites"
},
+ "tags": ["java"],
"name": "artist-web",
"uid": "2152f463-549d-4d8d-a94d-ce2b7676c6e2"
},
@@ -66,6 +67,8 @@ metadata:
annotations:
example.com/service-discovery: artistweb
circleci.com/project-slug: gh/example-org/artist-website
+ tags:
+ - java
spec:
type: website
lifecycle: production
@@ -232,6 +235,20 @@ The `backstage.io/` prefix is reserved for use by Backstage core components.
Values can be of any length, but are limited to being strings.
+### `tags` [optional]
+
+A list of single-valued strings, for example to classify catalog entities in
+various ways. This is different to the labels in metadata, as labels are
+key-value pairs.
+
+The values are user defined, for example the programming language used for the
+component, like `java` or `go`.
+
+This field is optional, and currently has no special semantics.
+
+Each tag must be sequences of `[a-zA-Z0-9]` separated by `-`, at most 63
+characters in total.
+
## Kind: Component
Describes the following entity kind:
diff --git a/docs/overview/roadmap.md b/docs/overview/roadmap.md
index 6acea71509..cfe43e3e86 100644
--- a/docs/overview/roadmap.md
+++ b/docs/overview/roadmap.md
@@ -3,37 +3,125 @@ id: roadmap
title: Project roadmap
---
-We created Backstage about 4 years ago. While our internal version of Backstage
-has had the benefit of time to mature and evolve, the first iteration of our
-open source version is still nascent. We are envisioning three phases of the
-project and we have already begun work on various aspects of these phases:
+## Current status
+
+> Backstage is currently in Alpha. This means that you can expect APIs and
+> features to change until we reach our
+> [Backstage Beta milestone](https://github.com/spotify/backstage/milestone/19).
+> Before we have API stability, plugins will need ongoing maintenance. It is
+> also recommended that teams who adopt Backstage today upgrades their
+> installation as new [releases](https://github.com/spotify/backstage/releases)
+> are available.
+
+## Phases
+
+We have divided the project into three high-level _phases_:
- 🐣 **Phase 1:** Extensible frontend platform (Done ✅) - You will be able to
easily create a single consistent UI layer for your internal infrastructure
and tools. A set of reusable
- [UX patterns and components](http://backstage.io/storybook) help ensure a
+ [UX patterns and components](https://backstage.io/storybook) help ensure a
consistent experience between tools.
- 🐢 **Phase 2:** Service Catalog
([alpha released](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha)) -
With a single catalog, Backstage makes it easy for a team to manage ten
services — and makes it possible for your company to manage thousands of them.
- Developers can get a uniform overview of all their software and related
- resources, regardless of how and where they are running, as well as an easy
- way to onboard and manage those resources.
- 🐇 **Phase 3:** Ecosystem (later) - Everyone's infrastructure stack is
different. By fostering a vibrant community of contributors we hope to provide
an ecosystem of Open Source plugins/integrations that allows you to pick the
tools that match your stack.
-Check out our [Milestones](https://github.com/spotify/backstage/milestones) and
-open [RFCs](https://github.com/spotify/backstage/labels/rfc) how they relate to
-the three Phases outlined above.
+## Detailed roadmap
-Our vision for Backstage is for it to become the trusted standard toolbox (read:
-UX layer) for the open source infrastructure landscape. Think of it like
-Kubernetes for developer experience. We realize this is an ambitious goal. We
-can’t do it alone. If this sounds interesting or you'd like to help us shape our
-product vision, we'd love to talk. You can email me directly:
+If you have questions about the roadmap or want to provide feedback, we would
+love to hear from you! Please create an
+[Issue](https://github.com/spotify/backstage/issues/new/choose), ping us on
+[Discord](https://discord.gg/EBHEGzX) or reach out directly at
[alund@spotify.com](mailto:alund@spotify.com).
+
+Want to help out? Awesome ❤️ Head over to
+[CONTRIBUTING](https://github.com/spotify/backstage/blob/master/CONTRIBUTING.md)
+guidelines to get started.
+
+### Ongoing work 🚧
+
+- **[Plugins for managing micro services end-2-end](https://github.com/spotify/backstage/milestone/14)** -
+ Out of the box Backstage will ship with a set of plugins (Overview, CI, API
+ and Docs) that will demonstrate how a user can manage a micro service and
+ follow a change all the way out in production. Completing this work will make
+ it much easier to see how a plugin can be built that integrates with the
+ Backstage Service Catalog.
+
+- **Backstage Design System** - By providing design guidelines for common plugin
+ layouts together, rich set of reusable UI components
+ ([Storybook](https://backstage.io/storybook)) and Figma design resources. The
+ Design System will make it easy to design and build plugins that are
+ consistent across the platform -- supporting both developers and designers.
+
+- **[TechDocs v1](https://github.com/spotify/backstage/milestone/16)** - Our
+ docs-like-code feature TechDocs working end to end.
+
+- **[Initial GraphQL API](https://github.com/spotify/backstage/milestone/13)** -
+ A GraphQL API will open up the rich metadata provided by Backstage in a single
+ query. Plugins can easily query this API as well as extend the model where
+ needed.
+
+- **Production deployments** - Provide instructions and default configurations
+ (e.g. through Helm charts) for easy deployments of Backstage and its
+ subsystems on Kubernetes.
+
+- **Cloud Cost Insights plugin (from Spotify)** - Spotify teams are fully
+ responsible for their own software, including the cost of the cloud resources
+ they use. By making our internal cost insights plugin available as open source
+ you will also be able to treat cost as an engineering problem, and make it
+ easy for your engineers to see their spend and where there's opportunity to
+ reduce waste.
+
+- Further improvements to platform documentation
+
+### Future work 🔮
+
+- **[Backstage Beta](https://github.com/spotify/backstage/milestone/19)** - The
+ platform APIs and features are stable and can be dependent on for production
+ use. After this plugins will require little to no maintenance.
+
+- **[Plugin marketplace](https://github.com/spotify/backstage/issues/2009)** -
+ As the ecosystem of Backstage plugins continues to grow it is becoming
+ increasingly hard to keep track of what plugins are available. To solve this
+ we imagine a "Plugin marketplace" that helps with discovery and installation
+ of plugins.
+
+- **Deploy a product demo at `demo.backstage.io`** - Deploy a typical Backstage
+ deployment available publicly so that people can click around and get a feel
+ for the product without having to install anything.
+
+- **[Global search](https://github.com/spotify/backstage/issues/1499)** - Extend
+ the basic search available in the Backstage Service Catalog with a global
+ search experience. Long term this search solution should be extensible, making
+ it possible for you add custom search results.
+
+- **[[TechDocs V.2] Stabilization release](https://github.com/spotify/backstage/milestone/17)** -
+ Platform stability and compatibility improvements.
+
+- **Additional auth providers** - Backstage should work for most (all!) auth
+ solutions. Since Backstage can be used by companies regardless of what cloud
+ (or on prem) you are using we are especially keen to get auth support for
+ [AWS](https://github.com/spotify/backstage/issues/290),
+ [Azure](https://github.com/spotify/backstage/issues/348) and others.
+
+### Completed milestones ✅
+
+- [Improved and move documentation to backstage.io](https://backstage.io/docs/overview/what-is-backstage)
+- [Backstage Service 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/spotify/backstage/milestone/15)
+- CI plugins: CircleCI, Jenkins, GitHub Actions and TravisCI
+- [Service API documentation](https://github.com/spotify/backstage/pull/1737)
+- Backstage Service Catalog can read from: GitHub, GitLab,
+ [Bitbucket](https://github.com/spotify/backstage/pull/1938)
+- Support auth providers: Google, Okta, GitHub, GitLab,
+ [auth0](https://github.com/spotify/backstage/pull/1611),
+ [AWS](https://github.com/spotify/backstage/pull/1990)
diff --git a/docs/overview/vision.md b/docs/overview/vision.md
new file mode 100644
index 0000000000..2ab7cdc6f4
--- /dev/null
+++ b/docs/overview/vision.md
@@ -0,0 +1,21 @@
+---
+id: vision
+title: Vision
+---
+
+Our goal is to provide engineers with the best developer experience in the
+world.
+
+A fantastic developer experience leads to happy, creative and productive
+engineers. Our belief is that engineers should not have to be experts in various
+infrastructure tools to be productive. Infrastructure should be abstracted away
+so that you can return to building and scaling, quickly and safely.
+
+
+
+We are working on making Backstage the trusted standard toolbox (read: UX layer)
+for the open source infrastructure landscape. Think of it like Kubernetes for
+developer experience. We realize this is an ambitious goal. We can’t do it
+alone. If this sounds interesting or you'd like to help us shape our product
+vision, we'd love to talk. You can email me directly:
+[alund@spotify.com](mailto:alund@spotify.com).
diff --git a/docs/overview/what-is-backstage.md b/docs/overview/what-is-backstage.md
index 163b6c219b..665e172c0b 100644
--- a/docs/overview/what-is-backstage.md
+++ b/docs/overview/what-is-backstage.md
@@ -28,9 +28,6 @@ Out of the box, Backstage includes:
[open source plugins](https://github.com/spotify/backstage/tree/master/plugins)
that further expand Backstage’s customizability and functionality
-For more information go to [backstage.io](https://backstage.io) or join our
-[Discord chatroom](https://discord.gg/EBHEGzX).
-
### Benefits
- For _engineering managers_, it allows you to maintain standards and best
@@ -45,3 +42,6 @@ For more information go to [backstage.io](https://backstage.io) or join our
- For _everyone_, it’s a single, consistent experience that ties all your
infrastructure tooling, resources, standards, owners, contributors, and
administrators together in one place.
+
+If you have questions or want support, please join our
+[Discord chatroom](https://discord.gg/EBHEGzX).
diff --git a/microsite/README copy.md b/microsite/README copy.md
deleted file mode 100644
index d7187888a3..0000000000
--- a/microsite/README copy.md
+++ /dev/null
@@ -1,182 +0,0 @@
-This website was created with [Docusaurus](https://docusaurus.io/).
-
-# What's In This Document
-
-- [Get Started in 5 Minutes](#get-started-in-5-minutes)
-- [Directory Structure](#directory-structure)
-- [Editing Content](#editing-content)
-- [Adding Content](#adding-content)
-- [Full Documentation](#full-documentation)
-
-## Directory Structure
-
-Your project file structure should look something like this
-
-```
-my-docusaurus/
- docs/
- doc-1.md
- doc-2.md
- doc-3.md
- website/
- blog/
- 2016-3-11-oldest-post.md
- 2017-10-24-newest-post.md
- core/
- node_modules/
- pages/
- static/
- css/
- img/
- package.json
- sidebars.json
- siteConfig.js
-```
-
-# Editing Content
-
-## Editing an existing docs page
-
-Edit docs by navigating to `docs/` and editing the corresponding document:
-
-`docs/doc-to-be-edited.md`
-
-```markdown
----
-id: page-needs-edit
-title: This Doc Needs To Be Edited
----
-
-Edit me...
-```
-
-For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Editing an existing blog post
-
-Edit blog posts by navigating to `website/blog` and editing the corresponding post:
-
-`website/blog/post-to-be-edited.md`
-
-```markdown
----
-id: post-needs-edit
-title: This Blog Post Needs To Be Edited
----
-
-Edit me...
-```
-
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-# Adding Content
-
-## Adding a new docs page to an existing sidebar
-
-1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
-
-```md
----
-id: newly-created-doc
-title: This Doc Needs To Be Edited
----
-
-My new content here..
-```
-
-1. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`:
-
-```javascript
-// Add newly-created-doc to the Getting Started category of docs
-{
- "docs": {
- "Getting Started": [
- "quick-start",
- "newly-created-doc" // new doc here
- ],
- ...
- },
- ...
-}
-```
-
-For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding a new blog post
-
-1. Make sure there is a header link to your blog in `website/siteConfig.js`:
-
-`website/siteConfig.js`
-
-```javascript
-headerLinks: [
- ...
- { blog: true, label: 'Blog' },
- ...
-]
-```
-
-2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
-
-`website/blog/2018-05-21-New-Blog-Post.md`
-
-```markdown
----
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: New Blog Post
----
-
-Lorem Ipsum...
-```
-
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-## Adding items to your site's top navigation bar
-
-1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
-
-`website/siteConfig.js`
-
-```javascript
-{
- headerLinks: [
- ...
- /* you can add docs */
- { doc: 'my-examples', label: 'Examples' },
- /* you can add custom pages */
- { page: 'help', label: 'Help' },
- /* you can add external links */
- { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' },
- ...
- ],
- ...
-}
-```
-
-For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding custom pages
-
-1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
-1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
-
-`website/siteConfig.js`
-
-```javascript
-{
- headerLinks: [
- ...
- { page: 'my-new-custom-page', label: 'My New Custom Page' },
- ...
- ],
- ...
-}
-```
-
-For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
-
-# Full Documentation
-
-Full documentation can be found on the [website](https://docusaurus.io/).
diff --git a/microsite/core/Footer.js b/microsite/core/Footer.js
index c44b8196a6..407bebca84 100644
--- a/microsite/core/Footer.js
+++ b/microsite/core/Footer.js
@@ -32,22 +32,15 @@ class Footer extends React.Component {
+
+ >
);
};
diff --git a/packages/core/src/layout/Header/Waves.test.tsx b/packages/core/src/layout/Header/Waves.test.tsx
deleted file mode 100644
index 76bf5e913e..0000000000
--- a/packages/core/src/layout/Header/Waves.test.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import React from 'react';
-import { render } from '@testing-library/react';
-import { pageTheme } from '../Page/PageThemeProvider';
-import { Waves } from './Waves';
-
-describe('', () => {
- it('should render svg', () => {
- const rendered = render();
- rendered.getByTestId('wave-svg');
- });
-});
diff --git a/packages/core/src/layout/Header/Waves.tsx b/packages/core/src/layout/Header/Waves.tsx
deleted file mode 100644
index e87fc78105..0000000000
--- a/packages/core/src/layout/Header/Waves.tsx
+++ /dev/null
@@ -1,148 +0,0 @@
-/*
- * Copyright 2020 Spotify AB
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import React, { FC } from 'react';
-import { makeStyles } from '@material-ui/core';
-import { PageTheme } from '../Page';
-
-const useStyles = makeStyles({
- wave: {
- position: 'absolute',
- height: '100%',
- width: '100%',
- top: 0,
- bottom: 0,
- left: 0,
- right: 0,
- zIndex: -1,
- },
-});
-
-type Props = {
- theme: PageTheme;
-};
-
-export const Waves: FC = ({ theme }) => {
- const classes = useStyles();
- const [backgroundColor1, backgroundColor2] = theme.gradient.colors;
- const waveColor = theme.gradient.waveColor;
- const [opacityStart, opacityStop] = theme.gradient.opacity;
-
- return (
-
- );
-};
diff --git a/packages/core/src/layout/Page/Page.tsx b/packages/core/src/layout/Page/Page.tsx
index bc4175fb6c..a5f5e4fd2b 100644
--- a/packages/core/src/layout/Page/Page.tsx
+++ b/packages/core/src/layout/Page/Page.tsx
@@ -18,7 +18,7 @@ import React, { FC } from 'react';
import { PageTheme, pageTheme } from './PageThemeProvider';
import { makeStyles } from '@material-ui/core';
-export const Theme = React.createContext(pageTheme.home);
+export const PageThemeContext = React.createContext(pageTheme.home);
const useStyles = makeStyles(() => ({
root: {
@@ -38,8 +38,8 @@ type Props = {
export const Page: FC = ({ theme = pageTheme.home, children }) => {
const classes = useStyles();
return (
-
+