Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update creation instructions #6

Merged
merged 2 commits into from
Jul 31, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This is a monorepo housing Cortex-maintained plugins for Cortex.

### Adding a plugin
1. Use Scaffolder to create a new plugin inside the `plugins` directory.
1. Use Scaffolder to create a new plugin inside the `plugins` directory. **IMPORTANT**: use the "Plugin in cortex-plugins" template on tenant `cortex` in prod or staging and point it at this repo with the subdirectory `plugins/{plugin-name}` (replace "{plugin-name}" with the name of your plugin).
FoodProduct marked this conversation as resolved.
Show resolved Hide resolved
2. Update the `tsconfig.json` file `typeRoots` property to include types at the root of the repo, 1.e.
```json
"typeRoots": ["../../node_modules/@types", "./node_modules/@types"],
Expand Down
Loading