Skip to content

Commit ebd023b

Browse files
authored
Add suggested text to template workspace README (#5995)
* Add suggested text to template workspace README Signed-off-by: Hope Hadfield <[email protected]> * Remove previous README text Signed-off-by: Hope Hadfield <[email protected]> * Use Handlebars and add original README content Signed-off-by: Hope Hadfield <[email protected]> --------- Signed-off-by: Hope Hadfield <[email protected]>
1 parent fe74366 commit ebd023b

File tree

2 files changed

+29
-16
lines changed

2 files changed

+29
-16
lines changed

workspaces/repo-tools/packages/cli/src/lib/workspaces/templates/workspace/README.md

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# [Backstage](https://backstage.io)
2+
3+
This is your newly scaffolded Backstage App, Good Luck!
4+
5+
> [!IMPORTANT]
6+
> **TODO**: Consider updating your README text with relevant documentation for your plugin. See some suggested text below.
7+
8+
# {{name}}
9+
10+
This workspace contains plugins for \[brief description of purpose, e.g. exposing data from a service].
11+
12+
## Plugins
13+
14+
- \[plugin-backend](./plugins/plugin-backend/README): Backend plugin that provides...
15+
16+
## Getting Started
17+
18+
To start the app, run:
19+
20+
```sh
21+
yarn install
22+
yarn start
23+
```
24+
25+
To generate knip reports for this app, run:
26+
27+
```sh
28+
yarn backstage-repo-tools knip-reports
29+
```

0 commit comments

Comments
 (0)