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

todo,todo-backend: updated READMEs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2021-03-10 23:12:16 +01:00
parent 4fb393e98f
commit c44db42c84
2 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/todo/README.md
+6 -10
View File
@@ -1,13 +1,9 @@
# todo
# @backstage/plugin-todo
Welcome to the todo plugin!
This plugins lists `// TODO` comments in source code. It currently exports a single component extension for use on entity pages.
_This plugin was created through the Backstage CLI_
## Extensions
## Getting started
Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/todo](http://localhost:3000/todo).
You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
| name | description |
| ------------------- | ------------------------------------------------------------------------------- |
| `EntityTodoContent` | Content for an entity page, showing a table of TODO items for the given entity. |