paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

rewrite other references to spotify/backstage and sorrounding things

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-11-03 11:39:12 +01:00
parent 606625d672
commit 474bb5b57f
31 changed files with 53 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf/writing.md
+1 -1
View File
@@ -19,7 +19,7 @@ backend:
baseUrl: http://localhost:7000
organization:
name: Spotify
name: CNCF
proxy:
/my/api:
docs/dls/design.md
+6 -6
View File
@@ -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/)
docs/features/software-catalog/well-known-annotations.md
+3 -3
View File
@@ -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
docs/features/software-templates/extending/create-your-own-preparer.md
+1 -1
View File
@@ -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),
docs/features/software-templates/extending/create-your-own-publisher.md
+1 -1
View File
@@ -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
docs/features/software-templates/extending/create-your-own-templater.md
+1 -1
View File
@@ -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),
docs/getting-started/running-backstage-locally.md
+1 -1
View File
@@ -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
docs/overview/architecture-overview.md
+2 -2
View File
@@ -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