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

Documentation editorial review (#3055)

Browse Source 
* Fix case and link

* Align product/vendor case

* Reword for readability

* YAML Case

* Align product names

* Align product and acronym case

* Remove here link and product naming

* Align Node.js naming

* Align product names

* Fix wording
This commit is contained in:
Adam Harvey
2020-10-23 02:01:07 -04:00
committed by GitHub
parent 628f782948
commit a06164da24
9 changed files with 51 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/support/project-structure.md
+23 -22
View File
@@ -71,38 +71,38 @@ Let's look at them individually.
### `packages/`
These are all the packages that is we use within the project.
[Plugins](#plugins) are separated out into their own folder, see further down.
These are all the packages that we use within the project. [Plugins](#plugins)
are separated out into their own folder, see further down.
- [`app/`](https://github.com/spotify/backstage/tree/master/packages/app) - This
is our take on how an App could look like, bringing together a set of packages
and plugins into a working Backstage App. This is not a published package, and
the main goals is to provide a demo of what an App could look like, and also
enabling local development.
the main goals are to provide a demo of what an App could look like and to
enable local development.
- [`backend/`](https://github.com/spotify/backstage/tree/master/packages/backend) -
Every standalone backstage project will have both an `app` _and_ a `backend`
Every standalone Backstage project will have both an `app` _and_ a `backend`
package. The `backend` uses plugins to construct a working backend that the
frontend (`app`) can use.
- [`backend-common/`](https://github.com/spotify/backstage/tree/master/packages/backend-common) -
There are no "core" packages in the backend. Instead we have `backend-common`
which contains helper middleware´s and other utils.
which contains helper middleware and other utils.
- [`catalog-model/`](https://github.com/spotify/backstage/tree/master/packages/catalog-model) -
You can considers this to be a library for working with the catalog of sorts.
You can consider this to be a library for working with the catalog of sorts.
It contains the definition of an
[Entity](https://backstage.io/docs/features/software-catalog/references#docsNav),
as well as validation an other logic related to it. This package can be used
as well as validation and other logic related to it. This package can be used
in both the frontend and the backend.
- [`cli/`](https://github.com/spotify/backstage/tree/master/packages/cli) - One
of the biggest packages in our project, the `cli` is used to build, serve,
diff, create-plugins and more. In the early days of this project, we started
out with calling tools directly - such as `eslint` - through package.json. But
as it was tricky to have a good development experience around that when we
out with calling tools directly - such as `eslint` - through `package.json`.
But as it was tricky to have a good development experience around that when we
change named tooling, we opted for wrapping those in our own cli. That way
everything looks the same in package.json. Much like
everything looks the same in `package.json`. Much like
[react-scripts](https://github.com/facebook/create-react-app/tree/master/packages/react-scripts).
- [`cli-common/`](https://github.com/spotify/backstage/tree/master/packages/cli-common) -
@@ -119,20 +119,21 @@ These are all the packages that is we use within the project.
* [`config-loader/`](https://github.com/spotify/backstage/tree/master/packages/config-loader) -
This package is used to read config objects. It does not know how to merge,
this only reads files and passes them on to the config. As this part os only
but only reads files and passes them on to the config. As this part is only
used by the backend, we chose to separate `config` and `config-loader` into
two different packages.
- [`core/`](https://github.com/spotify/backstage/tree/master/packages/core) -
This package contains our visual React components, some of which you can find
[here](https://backstage.io/storybook/?path=/story/plugins-examples--plugin-with-data).
in
[plugin examples](https://backstage.io/storybook/?path=/story/plugins-examples--plugin-with-data).
Apart from that it re-exports everything from [`core-api`] so that users only
need to rely on one package.
* [`core-api/`](https://github.com/spotify/backstage/tree/master/packages/core-api) -
This package contains apis and definitions of such. It is it's own package
This package contains APIs and definitions of such. It is it's own package
because we needed to split our `test-utils` package. It's an implementation
detail that we try to hide from our users, and no-one should have to depend on
detail that we try to hide from our users, and no one should have to depend on
it directly.
* [`test-utils/`](https://github.com/spotify/backstage/tree/master/packages/test-utils) -
@@ -140,7 +141,7 @@ These are all the packages that is we use within the project.
`core-api`.
* [`test-utils-core/`](https://github.com/spotify/backstage/tree/master/packages/test-utils-core) -
This package contains more general purpose testing facilities for testing an
This package contains more general purpose testing facilities for testing a
Backstage App.
* [`create-app/`](https://github.com/spotify/backstage/tree/master/packages/create-app) -
@@ -181,7 +182,7 @@ These are all the packages that is we use within the project.
### `plugins/`
Most of the functionality of an Backstage App comes from plugins. Even core
Most of the functionality of a Backstage App comes from plugins. Even core
features can be plugins, take the
[catalog](https://github.com/spotify/backstage/tree/master/plugins/catalog) as
an example.
@@ -199,7 +200,7 @@ through the
## Packages outside of the monorepo
For convenience we include packages in our project that is not part of our
For convenience we include packages in our project that are not part of our
monorepo setup.
- [`microsite/`](https://github.com/spotify/backstage/blob/master/microsite) -
@@ -220,17 +221,17 @@ future.
that this folder use the public registry.
- [`.vale.ini`](https://github.com/spotify/backstage/tree/master/.vale.ini) -
[Spell checker](https://github.com/errata-ai/vale) for markdown files
[Spell checker](https://github.com/errata-ai/vale) for Markdown files.
- [`.yarnrc`](https://github.com/spotify/backstage/tree/master/.yarnrc) -
Enforces "our" version of yarn.
Enforces "our" version of Yarn.
- [`app-config.yaml`](https://github.com/spotify/backstage/tree/master/app-config.yaml) -
Configuration for the app, both frontend and backend
Configuration for the app, both frontend and backend.
- [`catalog-info.yaml`](https://github.com/spotify/backstage/tree/master/catalog-info.yaml) -
Description of Backstage in the Backstage Entity format.
- [`lerna.json`](https://github.com/spotify/backstage/tree/master/lerna.json) -
[lerna](https://github.com/lerna/lerna) monorepo config. We are using
[Lerna](https://github.com/lerna/lerna) monorepo config. We are using
`yarn workspaces`, so this will only be used for executing scripts.