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

Updated root README docs

Browse Source
This commit is contained in:
Bilawal Hameed
2020-02-07 11:55:37 +01:00
parent ee5f49b7a2
commit 707264a9b1
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -10,10 +10,10 @@ Backstage is an open platform for building developer portals.
### Protobuf Definitions
To generate the Protobuf definitions in Go and TypeScript, run the following command from the root with [Prototool](https://github.com/uber/prototool):
To generate the Protobuf definitions in Go and TypeScript, run the following command from the root to run [Prototool](https://github.com/uber/prototool):
```bash
$ prototool generate ./proto
$ make build-protocol-definitions
```
See [proto/README.md](proto/README.md) for more information.
@@ -25,13 +25,13 @@ See [proto/README.md](proto/README.md) for more information.
Run the following:
```bash
$ ./tools/cookiecutter/init.sh frontend/packages/plugins/_template --output-dir frontend/packages/plugins
$ make scaffold-new-frontend-plugin
```
This will generate a plugin in the `frontend/packages/plugins` folder. It is important to note you will still need to include the plugin in your `frontend/packages/app` in the `package.json`. You will then be able to import it as follows:
```bash
$ ./tools/cookiecutter/init.sh frontend/packages/plugins/_template --output-dir frontend/packages/plugins
$ make scaffold-new-frontend-plugin
plugin_name [example-plugin]: github-api
$ vim frontend/packages/app/package.json