-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #126 from kubeshop/olelensmar/docs/validator-docs-…
…and-templates Improved docs and added templates to create-monokle-plugin
- Loading branch information
Showing
41 changed files
with
3,806 additions
and
451 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: argocd-cm | ||
labels: | ||
app.kubernetes.io/name: argocd-cm | ||
app.kubernetes.io/part-of: argocds |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
plugins: | ||
argo: true | ||
rules: | ||
argo/argo-config-maps: "warn" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,63 @@ | ||
<p align="center"> | ||
<img src="docs/images/large-icon-256.png" alt="Monokle Logo" width="128" height="128"/> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/kubeshop/monokle-core/tree/main/packages/validation"> | ||
<img title="mit licence" src="https://img.shields.io/badge/License-MIT-yellow.svg"/> | ||
</a> | ||
</p> | ||
|
||
# Welcome to Create Monokle Plugin | ||
|
||
Use this library to scaffold your custom Monokle validation plugin in seconds - which can then | ||
be used locally or contributed to our [Monokle Community Plugins](https://github.com/kubeshop/monokle-community-plugins) repository. | ||
|
||
## Table of contents | ||
|
||
- [Usage](#usage) | ||
- [Interactive](#interactive) | ||
- [Create a TypeScript validation plugin](#create-a-typescript-validation-plugin) | ||
- [Example](#example) | ||
- [Acknowledgements](#acknowledgements) | ||
Read more about custom plugins in the [Custom Validator documentation](../validation/docs/custom-plugins.md) | ||
|
||
## Usage | ||
|
||
Prerequisite: it's recommended to use NodeJs LTS or higher and NPM 7+. | ||
|
||
### Interactive | ||
|
||
``` | ||
Running in interactive mode: | ||
|
||
```shell | ||
npm create monokle-plugin@latest | ||
``` | ||
|
||
will prompt for: | ||
|
||
```shell | ||
✔ Plugin name: … my-validation-plugin | ||
✔ Select a plugin type: › validation | ||
✔ Select a variant: › validation-ts | ||
✔ Select a template: › basic | ||
|
||
Scaffolding plugin in /Users/olensmar/WebstormProjects/monokle-core/packages/create-monokle-plugin/my-validation-plugin... | ||
|
||
Done. Now run: | ||
|
||
cd my-validation-plugin | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
Now you're all set to implement your [Custom Plugin](../validation/docs/custom-plugins.md) | ||
|
||
### Create a TypeScript validation plugin | ||
|
||
``` | ||
npm create monokle-plugin@latest my-validator -- --template validation-ts | ||
``` | ||
|
||
### Example | ||
### Sharing plugins | ||
|
||
Head over to the [Monokle Community Plugins](https://github.com/kubeshop/monokle-community-plugins) repo for an | ||
example on how to get started with your own plugin. | ||
Head over to the [Monokle Community Plugins](https://github.com/kubeshop/monokle-community-plugins) repo to see existing | ||
community plugins and learn how you can create and share your own. | ||
|
||
## Acknowledgements | ||
|
||
This project is a modified version of [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite) and | ||
most credits go to them. | ||
|
||
<p align="center"> | ||
<img src="docs/images/large-icon-256.png" alt="Monokle Logo" width="128" height="128"/> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/kubeshop/monokle-core/tree/main/packages/validation"> | ||
<img title="mit licence" src="https://img.shields.io/badge/License-MIT-yellow.svg"/> | ||
</a> | ||
</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.