Merge pull request #3214 from backstage/rugvip/spotirefs
rewrite other references to spotify/backstage and sorrounding things
This commit is contained in:
Patrik Oldsberg
@@ -7,7 +7,7 @@
|
||||
[](https://github.com/backstage/backstage/actions?query=workflow%3A%22Main+Master+Build%22)
|
||||
[](https://discord.gg/EBHEGzX)
|
||||
|
||||
[](https://codecov.io/gh/spotify/backstage)
|
||||
[](https://codecov.io/gh/backstage/backstage)
|
||||
[](https://github.com/backstage/backstage/releases)
|
||||
|
||||
> We recently moved from `spotify/backstage`, update your remotes!
|
||||
|
||||
+2
-2
@@ -5,10 +5,10 @@ metadata:
|
||||
description: |
|
||||
Backstage is an open-source developer portal that puts the developer experience first.
|
||||
annotations:
|
||||
github.com/project-slug: spotify/backstage
|
||||
github.com/project-slug: backstage/backstage
|
||||
backstage.io/techdocs-ref: github:https://github.com/backstage/backstage.git
|
||||
lighthouse.com/website-url: https://backstage.io
|
||||
spec:
|
||||
type: library
|
||||
owner: Spotify
|
||||
owner: CNCF
|
||||
lifecycle: experimental
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
apiVersion: v2
|
||||
name: backstage
|
||||
description: A Helm chart for Spotify Backstage
|
||||
description: A Helm chart for Backstage
|
||||
type: application
|
||||
|
||||
# This is the chart version. This version number should be incremented each time you make changes
|
||||
|
||||
@@ -105,14 +105,14 @@ appConfig:
|
||||
rejectUnauthorized: false
|
||||
ca:
|
||||
sentry:
|
||||
organization: spotify
|
||||
organization: example-org-name
|
||||
techdocs:
|
||||
storageUrl: https://demo.example.com/api/techdocs/static/docs
|
||||
requestUrl: https://demo.example.com/api/techdocs
|
||||
lighthouse:
|
||||
baseUrl: https://demo.example.com/lighthouse-api
|
||||
rollbar:
|
||||
organization: roadie
|
||||
organization: example-org-name
|
||||
|
||||
# Auth config has recently moved into the app config file in upstream Backstage. However,
|
||||
# most of this config simply mandates that items like the client id and client secret should
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
apiVersion: v1
|
||||
appVersion: '1.0'
|
||||
description: A Helm chart for Spotify Backstage
|
||||
description: A Helm chart for Backstage
|
||||
name: backstage
|
||||
version: 0.1.1-alpha.12
|
||||
|
||||
@@ -19,7 +19,7 @@ backend:
|
||||
baseUrl: http://localhost:7000
|
||||
|
||||
organization:
|
||||
name: Spotify
|
||||
name: CNCF
|
||||
|
||||
proxy:
|
||||
/my/api:
|
||||
|
||||
+6
-6
@@ -46,9 +46,9 @@ referencing Figma documents to share specs and prototypes with the community.
|
||||
|
||||
### Creating a New Design Component
|
||||
|
||||
| Step 1 | Step 2 | Step 3 | Step 4 | Step 5 | Step 6 |
|
||||
| :------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- |
|
||||
| Platform design team submits an issue to **spotify/Backstage GitHub** with a potential component. | Backstage community offers feedback or approval on **spotify/Backstage GitHub**. | Platform design team adjusts accordingly (as they see fit) and update the Figma DLS document. | Designed component is added to **spotify/Backstage GitHub** as an issue. | External or internal Backstage open source contributors build the component. | External or internal contributors add the component to the **Backstage Storybook**. 🎉 |
|
||||
| Step 1 | Step 2 | Step 3 | Step 4 | Step 5 | Step 6 |
|
||||
| :-------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------- | :--------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- |
|
||||
| Platform design team submits an issue to **backstage/backstage GitHub** with a potential component. | Backstage community offers feedback or approval on **backstage/backstage GitHub**. | Platform design team adjusts accordingly (as they see fit) and update the Figma DLS document. | Designed component is added to **backstage/backstage GitHub** as an issue. | External or internal Backstage open source contributors build the component. | External or internal contributors add the component to the **Backstage Storybook**. 🎉 |
|
||||
|
||||
### Building for Backstage
|
||||
|
||||
@@ -56,9 +56,9 @@ referencing Figma documents to share specs and prototypes with the community.
|
||||
| :------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------- |
|
||||
| External or internal contributors use Backstage and come up with an idea of an entity to build for Backstage. | External or internal contributors refer to the Backstage Open Source design system documentation in the Figma DLS document. | External or internal contributors leverage the components and tokens from the Backstage Storybook. | External or internal contributors build their Backstage entity. |
|
||||
|
||||
| Step 5 | Step 6 | Step 7 | Step 8 |
|
||||
| :------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ |
|
||||
| External or internal contributors make a pull request for their entity on spotify/Backstage GitHub for review. | Platform designers and devs review the entity and submit feedback or approval on spotify/Backstage GitHub. | External or internal contributors make the changes, pull request is approved and the entity is merged. It’s live on Backstage! 🎉 | If the entity happens to be or include a UX component, it’s added to Backstage Storybook as well. |
|
||||
| Step 5 | Step 6 | Step 7 | Step 8 |
|
||||
| :--------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ |
|
||||
| External or internal contributors make a pull request for their entity on backstage/backstage GitHub for review. | Platform designers and devs review the entity and submit feedback or approval on backstage/backstage GitHub. | External or internal contributors make the changes, pull request is approved and the entity is merged. It’s live on Backstage! 🎉 | If the entity happens to be or include a UX component, it’s added to Backstage Storybook as well. |
|
||||
|
||||
The following diagram shows the relationship between the Backstage Design System
|
||||
and our foundation, which comprises of [Material UI](https://material-ui.com/)
|
||||
|
||||
@@ -75,7 +75,7 @@ that entity.
|
||||
# Example:
|
||||
metadata:
|
||||
annotations:
|
||||
github.com/project-slug: spotify/backstage
|
||||
github.com/project-slug: backstage/backstage
|
||||
```
|
||||
|
||||
The value of this annotation is the so-called slug that identifies a project on
|
||||
@@ -93,7 +93,7 @@ that entity.
|
||||
# Example:
|
||||
metadata:
|
||||
annotations:
|
||||
github.com/team-slug: spotify/backstage-core
|
||||
github.com/team-slug: backstage/maintainers
|
||||
```
|
||||
|
||||
The value of this annotation is the so-called slug that identifies a team on
|
||||
@@ -146,7 +146,7 @@ that entity.
|
||||
# Example:
|
||||
metadata:
|
||||
annotations:
|
||||
rollbar.com/project-slug: spotify/pump-station
|
||||
rollbar.com/project-slug: backstage/pump-station
|
||||
```
|
||||
|
||||
The value of this annotation is the so-called slug (or alternatively, the ID) of
|
||||
|
||||
@@ -15,7 +15,7 @@ location protocols:
|
||||
- `github://`
|
||||
|
||||
These two are added to the `PreparersBuilder` and then passed into the
|
||||
`createRouter` function of the `@spotify/plugin-scaffolder-backend`.
|
||||
`createRouter` function of the `@backstage/plugin-scaffolder-backend`.
|
||||
|
||||
A full example backend can be found in
|
||||
[`scaffolder.ts`](https://github.com/backstage/backstage/blob/d91c10f654475a60829fa33a5c81018e517a319a/packages/backend/src/plugins/scaffolder.ts),
|
||||
|
||||
@@ -18,7 +18,7 @@ Currently we provide the following `publishers`:
|
||||
- `github`
|
||||
|
||||
This publisher is passed through to the `createRouter` function of the
|
||||
`@spotify/plugin-scaffolder-backend`. Currently, only one publisher is
|
||||
`@backstage/plugin-scaffolder-backend`. Currently, only one publisher is
|
||||
supported, but PR's are always welcome.
|
||||
|
||||
An full example backend can be found
|
||||
|
||||
@@ -17,7 +17,7 @@ Currently we provide the following templaters:
|
||||
- `cookiecutter`
|
||||
|
||||
This templater is added to the `TemplaterBuilder` and then passed into the
|
||||
`createRouter` function of the `@spotify/plugin-scaffolder-backend`
|
||||
`createRouter` function of the `@backstage/plugin-scaffolder-backend`
|
||||
|
||||
An full example backend can be found
|
||||
[here](https://github.com/backstage/backstage/blob/d91c10f654475a60829fa33a5c81018e517a319a/packages/backend/src/plugins/scaffolder.ts),
|
||||
|
||||
@@ -42,7 +42,7 @@ of GitHub and run an initial build.
|
||||
|
||||
```bash
|
||||
# Start from your local development folder
|
||||
git clone --depth 1 git@github.com:spotify/backstage.git
|
||||
git clone --depth 1 git@github.com:backstage/backstage.git
|
||||
cd backstage
|
||||
|
||||
# Fetch our dependencies and run an initial build
|
||||
|
||||
@@ -169,8 +169,8 @@ in the future.
|
||||
To learn more about the future of databases and Backstage, see the following
|
||||
GitHub issues.
|
||||
|
||||
- [Knex + Plugins (Multiple vs Single Database) · Issue #1598 · spotify/backstage](https://github.com/backstage/backstage/issues/1598)
|
||||
- [Update migrations to support postgres by dariddler · Pull Request #1527 · spotify/backstage](https://github.com/backstage/backstage/pull/1527#discussion_r450374145)
|
||||
- [Knex + Plugins (Multiple vs Single Database) · Issue #1598 · backstage/backstage](https://github.com/backstage/backstage/issues/1598)
|
||||
- [Update migrations to support postgres by dariddler · Pull Request #1527 · backstage/backstage](https://github.com/backstage/backstage/pull/1527#discussion_r450374145)
|
||||
|
||||
## Containerization
|
||||
|
||||
|
||||
@@ -70,7 +70,7 @@ To keep up with our latest design guidelines, go to [Designing for Backstage](ht
|
||||
|
||||
### [GitHub](https://github.com/backstage/backstage)
|
||||
|
||||
Join in on the action [at spotify/backstage on GitHub](https://github.com/backstage/backstage) by submitting issues and opening pull requests for all things related to components and patterns in Backstage.
|
||||
Join in on the action [at backstage/backstage on GitHub](https://github.com/backstage/backstage) by submitting issues and opening pull requests for all things related to components and patterns in Backstage.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -59,7 +59,7 @@ class Footer extends React.Component {
|
||||
className="github-button"
|
||||
href={this.props.config.repoUrl}
|
||||
data-icon="octicon-star"
|
||||
data-count-href="/spotify/backstage/stargazers"
|
||||
data-count-href="/backstage/backstage/stargazers"
|
||||
data-show-count="true"
|
||||
data-count-aria-label="# stargazers on GitHub"
|
||||
aria-label="Star this project on GitHub"
|
||||
|
||||
@@ -20,7 +20,7 @@ import path from 'path';
|
||||
const TEAM_ID_RE = /^@[-\w]+\/[-\w]+$/;
|
||||
const USER_ID_RE = /^@[-\w]+$/;
|
||||
const EMAIL_RE = /^[^@]+@[-.\w]+\.[-\w]+$/i;
|
||||
const DEFAULT_OWNER = '@spotify/backstage-core';
|
||||
const DEFAULT_OWNER = '@backstage/maintainers';
|
||||
|
||||
type CodeownersEntry = {
|
||||
ownedPath: string;
|
||||
|
||||
@@ -5,7 +5,7 @@ metadata:
|
||||
description: An example of a Backstage application.
|
||||
# Example for optional annotations
|
||||
# annotations:
|
||||
# github.com/project-slug: spotify/backstage
|
||||
# github.com/project-slug: backstage/backstage
|
||||
# backstage.io/techdocs-ref: github:https://github.com/backstage/backstage.git
|
||||
spec:
|
||||
type: website
|
||||
|
||||
@@ -24,7 +24,7 @@ Then open up `http://localhost:8000` on your local machine.
|
||||
|
||||
This container is published on DockerHub - https://hub.docker.com/r/spotify/techdocs
|
||||
|
||||
The publishing is configured by [Automated Builds](https://hub.docker.com/repository/docker/spotify/techdocs/builds/edit) feature on Docker Hub which is triggered from GitHub (on new commits and releases). @spotify/techdocs-core team has access to the settings.
|
||||
The publishing is configured by [Automated Builds](https://hub.docker.com/repository/docker/spotify/techdocs/builds/edit) feature on Docker Hub which is triggered from GitHub (on new commits and releases). @backstage/techdocs-core team has access to the settings.
|
||||
|
||||
The `latest` tag on Docker Hub points to the recent commits in the `master` branch. The [version tags](https://hub.docker.com/r/spotify/techdocs/tags) (e.g. v0.1.1-alpha.24) point to the GitHub tags created from [releases](https://github.com/backstage/backstage/releases) of this GitHub repository.
|
||||
|
||||
|
||||
@@ -182,7 +182,7 @@ export function readConfig(config: Config): ProviderConfig[] {
|
||||
export function parseUrl(urlString: string): { org: string } {
|
||||
const path = new URL(urlString).pathname.substr(1).split('/');
|
||||
|
||||
// /spotify
|
||||
// /backstage
|
||||
if (path.length === 1 && path[0].length) {
|
||||
return { org: decodeURIComponent(path[0]) };
|
||||
}
|
||||
|
||||
@@ -34,7 +34,7 @@ describe('parseEntityYaml', () => {
|
||||
name: backstage
|
||||
description: backstage.io
|
||||
annotations:
|
||||
github.com/project-slug: 'spotify/backstage'
|
||||
github.com/project-slug: 'backstage/backstage'
|
||||
spec:
|
||||
type: website
|
||||
lifecycle: production
|
||||
@@ -54,7 +54,7 @@ describe('parseEntityYaml', () => {
|
||||
name: 'backstage',
|
||||
description: 'backstage.io',
|
||||
annotations: {
|
||||
'github.com/project-slug': 'spotify/backstage',
|
||||
'github.com/project-slug': 'backstage/backstage',
|
||||
},
|
||||
},
|
||||
spec: {
|
||||
|
||||
@@ -26,8 +26,7 @@ TBD
|
||||
name: backstage
|
||||
description: backstage.io
|
||||
annotations:
|
||||
github.com/project-slug: 'spotify/backstage'
|
||||
|
||||
github.com/project-slug: 'backstage/backstage'
|
||||
spec:
|
||||
type: website
|
||||
lifecycle: production
|
||||
|
||||
@@ -4,7 +4,7 @@ metadata:
|
||||
name: backstage
|
||||
description: backstage.io
|
||||
annotations:
|
||||
github.com/project-slug: 'spotify/backstage'
|
||||
github.com/project-slug: 'backstage/backstage'
|
||||
backstage.io/techdocs-ref: github:https://github.com/backstage/backstage.git
|
||||
spec:
|
||||
type: website
|
||||
|
||||
@@ -8,7 +8,7 @@ The following values are read from the configuration file.
|
||||
|
||||
```yaml
|
||||
rollbar:
|
||||
organization: spotify
|
||||
organization: organization-name
|
||||
accountToken:
|
||||
$env: ROLLBAR_ACCOUNT_TOKEN
|
||||
```
|
||||
|
||||
@@ -53,7 +53,7 @@ const ServiceEntityPage = ({ entity }: { entity: Entity }) => (
|
||||
```yaml
|
||||
# app.config.yaml
|
||||
rollbar:
|
||||
organization: spotify
|
||||
organization: organization-name
|
||||
accountToken:
|
||||
$env: ROLLBAR_ACCOUNT_TOKEN
|
||||
```
|
||||
|
||||
@@ -9,13 +9,13 @@ metadata:
|
||||
- techdocs
|
||||
- mkdocs
|
||||
spec:
|
||||
owner: spotify/techdocs-core
|
||||
owner: backstage/techdocs-core
|
||||
templater: cookiecutter
|
||||
type: documentation
|
||||
path: '.'
|
||||
|
||||
|
||||
schema:
|
||||
required:
|
||||
required:
|
||||
- component_id
|
||||
- description
|
||||
properties:
|
||||
@@ -27,4 +27,3 @@ spec:
|
||||
title: Description
|
||||
type: string
|
||||
description: Help others understand what these docs are about.
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ describe('JobProcessor', () => {
|
||||
|
||||
const mockValues: RequiredTemplateValues = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/mock-repo',
|
||||
storePath: 'backstage/mock-repo',
|
||||
};
|
||||
|
||||
describe('create', () => {
|
||||
|
||||
@@ -24,7 +24,7 @@ describe('Preparers', () => {
|
||||
metadata: {
|
||||
annotations: {
|
||||
'backstage.io/managed-by-location':
|
||||
'file:/Users/bingo/spotify/backstage/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml',
|
||||
'file:/Users/bingo/backstage/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml',
|
||||
},
|
||||
name: 'react-ssr-template',
|
||||
title: 'React SSR Template',
|
||||
|
||||
@@ -51,12 +51,12 @@ describe('CookieCutter Templater', () => {
|
||||
return await fs.promises.mkdtemp(path.join(tempDir, 'temp'));
|
||||
};
|
||||
|
||||
it('should write a cookiecutter.json file with the values from the entitiy', async () => {
|
||||
it('should write a cookiecutter.json file with the values from the entity', async () => {
|
||||
const tempdir = await mkTemp();
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
description: 'description',
|
||||
component_id: 'newthing',
|
||||
};
|
||||
@@ -78,7 +78,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
component_id: 'something',
|
||||
};
|
||||
|
||||
@@ -96,7 +96,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
};
|
||||
|
||||
await expect(
|
||||
@@ -109,7 +109,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
component_id: 'newthing',
|
||||
};
|
||||
|
||||
@@ -137,7 +137,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
component_id: 'newthing',
|
||||
};
|
||||
|
||||
@@ -157,7 +157,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
component_id: 'newthing',
|
||||
};
|
||||
|
||||
@@ -203,7 +203,7 @@ describe('CookieCutter Templater', () => {
|
||||
|
||||
const values = {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
component_id: 'newthing',
|
||||
};
|
||||
|
||||
@@ -243,7 +243,7 @@ describe('CookieCutter Templater', () => {
|
||||
directory: tempdir,
|
||||
values: {
|
||||
owner: 'blobby',
|
||||
storePath: 'spotify/end-repo',
|
||||
storePath: 'backstage/end-repo',
|
||||
},
|
||||
logStream: stream,
|
||||
dockerClient: mockDocker,
|
||||
|
||||
@@ -24,7 +24,7 @@ describe('Templaters', () => {
|
||||
metadata: {
|
||||
annotations: {
|
||||
'backstage.io/managed-by-location':
|
||||
'file:/Users/bingo/spotify/backstage/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml',
|
||||
'file:/Users/bingo/backstage/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml',
|
||||
},
|
||||
name: 'react-ssr-template',
|
||||
title: 'React SSR Template',
|
||||
|
||||
@@ -90,6 +90,6 @@ metadata:
|
||||
sonarqube.org/project-key: YOUR_PROJECT_KEY
|
||||
spec:
|
||||
type: library
|
||||
owner: Spotify
|
||||
owner: CNCF
|
||||
lifecycle: experimental
|
||||
```
|
||||
|
||||
@@ -27,7 +27,7 @@ async function verifyUrl(basePath, absUrl, docPages) {
|
||||
// Avoid having absolute URL links within docs/, so that links work on the site
|
||||
if (
|
||||
absUrl.match(
|
||||
/https:\/\/github.com\/spotify\/backstage\/(tree|blob)\/master\/docs\//,
|
||||
/https:\/\/github.com\/backstage\/backstage\/(tree|blob)\/master\/docs\//,
|
||||
) &&
|
||||
basePath.match(/^(?:docs|microsite)\//)
|
||||
) {
|
||||
@@ -37,7 +37,7 @@ async function verifyUrl(basePath, absUrl, docPages) {
|
||||
const url = absUrl
|
||||
.replace(/#.*$/, '')
|
||||
.replace(
|
||||
/https:\/\/github.com\/spotify\/backstage\/(tree|blob)\/master/,
|
||||
/https:\/\/github.com\/backstage\/backstage\/(tree|blob)\/master/,
|
||||
'',
|
||||
);
|
||||
if (!url) {
|
||||
|
||||
Reference in New Issue
Block a user