[Docs] Various fixes (#2136)

* [Docs] Various fixes

* More fixes

* Fix ADRs

* Typo
This commit is contained in:
Stefan Ålund
2020-08-27 13:27:22 +02:00
committed by GitHub
parent 2bb585f4fe
commit a8edb19f61
29 changed files with 118 additions and 338 deletions
+9 -9
View File
@@ -51,7 +51,7 @@
"title": "Adding authentication providers"
},
"auth/auth-backend-classes": {
"title": "auth/auth-backend-classes"
"title": "Auth backend classes"
},
"auth/auth-backend": {
"title": "Auth backend"
@@ -103,7 +103,8 @@
"title": "External integrations"
},
"features/software-catalog/software-catalog-overview": {
"title": "Backstage Service Catalog (alpha)"
"title": "Backstage Service Catalog (alpha)",
"sidebar_label": "Backstage Service Catalog"
},
"features/software-catalog/installation": {
"title": "features/software-catalog/installation"
@@ -174,9 +175,6 @@
"getting-started/installation": {
"title": "Installation"
},
"journey": {
"title": "journey"
},
"overview/adopting": {
"title": "Strategies for adopting"
},
@@ -186,6 +184,9 @@
"overview/architecture-terminology": {
"title": "Architecture terminology"
},
"overview/background": {
"title": "The Spotify Story"
},
"overview/roadmap": {
"title": "Project roadmap"
},
@@ -214,7 +215,7 @@
"title": "Intro to plugins"
},
"plugins/plugin-development": {
"title": "Plugin Development in Backstage"
"title": "Plugin Development"
},
"plugins/proxying": {
"title": "Proxying"
@@ -285,8 +286,8 @@
"reference/utility-apis/StorageApi": {
"title": "reference/utility-apis/StorageApi"
},
"tutorials/index": {
"title": "Overview"
"tutorials/journey": {
"title": "Future developer journey"
}
},
"links": {
@@ -294,7 +295,6 @@
"Docs": "Docs",
"Blog": "Blog",
"Demos": "Demos",
"The Spotify story": "The Spotify story",
"Newsletter": "Newsletter"
},
"categories": {
-122
View File
@@ -1,122 +0,0 @@
/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
const React = require('react');
const Components = require(`${process.cwd()}/core/Components.js`);
const Block = Components.Block;
const Breakpoint = Components.Breakpoint;
const Background = props => {
const { config: siteConfig } = props;
const { baseUrl } = siteConfig;
return (
<div className="mainWrapper">
<Block>
<Block.Container column>
<Block.TitleBox story>The Spotify Story</Block.TitleBox>
<Block.TextBox>
<Block.Paragraph>
Backstage was born out of necessity at Spotify. We found that as
we grew, our infrastructure was becoming more fragmented, our
engineers less productive.{' '}
</Block.Paragraph>
<Block.Paragraph>
Instead of building and testing code, teams were spending more
time looking for the right information just to get started.
Wheres the API for that service were all supposed to be using?
What version of that framework is everyone on? This service
isnt responding, who owns it? I cant find documentation for
anything!{' '}
</Block.Paragraph>
<Breakpoint
narrow={
<Block small>
<Block.QuoteContainer>
<Block.Divider quote />
<Block.Quote>
One place for everything. Accessible to everyone.
</Block.Quote>
</Block.QuoteContainer>
</Block>
}
></Breakpoint>
<Block.Paragraph>
Context switching and cognitive overload were dragging engineers
down, day by day. We needed to make it easier for our engineers to
do their work without having to become an expert in every aspect
of infrastructure tooling.
</Block.Paragraph>
<Block.Paragraph>
Our idea was to centralize and simplify end-to-end software
development with an abstraction layer that sits on top of all of
our infrastructure and developer tooling. Thats Backstage.
</Block.Paragraph>
<Block.Paragraph>
Its a developer portal powered by a centralized service catalog
with a plugin architecture that makes it endlessly extensible and
customizable.
</Block.Paragraph>
<Block.Paragraph>
Manage all your services, software, tooling, and testing in
Backstage. Start building a new microservice using an automated
template in Backstage. Create, maintain, and find the
documentation for all that software in Backstage.{' '}
</Block.Paragraph>
<Block.Paragraph>
One place for everything. Accessible to everyone.
</Block.Paragraph>
<Breakpoint
narrow={
<Block small>
<Block.LinkButton stretch href={'https://backstage.io/'}>
Explore Features
</Block.LinkButton>
</Block>
}
></Breakpoint>
</Block.TextBox>
</Block.Container>
</Block>
<Breakpoint
wide={
<Block small>
<Block.QuoteContainer>
<Block.Divider quote />
<Block.Quote>
One place for everything. Accessible to everyone.
</Block.Quote>
<Block.LinkButton stretch href={'https://backstage.io/'}>
Explore Features
</Block.LinkButton>
</Block.QuoteContainer>
</Block>
}
></Breakpoint>
<div
style={{
zIndex: -1,
position: 'absolute',
top: 0,
left: 0,
right: 0,
bottom: 0,
backgroundImage: `linear-gradient( to bottom, rgb(18, 18, 18), rgba(0, 0, 0, 0) ), url(../img/dot.svg)`,
}}
/>
</div>
);
};
module.exports = Background;
+2 -2
View File
@@ -6,6 +6,7 @@
"overview/architecture-terminology",
"overview/roadmap",
"overview/vision",
"overview/background",
"overview/adopting"
],
"Getting Started": [
@@ -38,7 +39,6 @@
"features/software-catalog/software-catalog-overview",
"features/software-catalog/system-model",
"features/software-catalog/descriptor-format",
"features/software-catalog/populating-catalog",
"features/software-catalog/extending-the-model",
"features/software-catalog/external-integrations",
"features/software-catalog/software-catalog-api"
@@ -132,7 +132,7 @@
"ids": ["api/backend"]
}
],
"Tutorials": ["tutorials/index"],
"Tutorials": ["tutorials/journey"],
"Architecture Decision Records (ADRs)": [
"architecture-decisions/adrs-overview",
"architecture-decisions/adrs-adr001",
-4
View File
@@ -47,10 +47,6 @@ const siteConfig = {
page: 'demos',
label: 'Demos',
},
{
page: 'background',
label: 'The Spotify story',
},
{
href: 'https://mailchi.mp/spotify/backstage-community',
label: 'Newsletter',