fix: playbook parameter docs

.github/workflows/style.yml

@@ -1,13 +1,27 @@
 name: Vale
 on:
-  push:
+  pull_request:
 
 jobs:
   vale:
     name: runner / vale
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: errata-ai/vale-action@reviewdog
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+
+      - name: List changed fiels
+        run: |
+          echo "Files changed:"
+          echo "${{ steps.changed-files.outputs.all_changed_files }}" | tr ' ' '\n'
+
+      - name: Run Vale on changed files
+        uses: errata-ai/vale-action@reviewdog
         with:
-          reporter: github-check
+          files: ${{ steps.changed-files.outputs.all_changed_files }}
+          separator: " "
+          reporter: github-pr-check
+          fail_on_error: true

mission-control/docs/playbooks/index.mdx

@@ -23,80 +23,30 @@ Some key benefits include:
 * **Cost Efficiency** - Optimize costs with on-demand environments that spin down after a fixed duration.
 * **Portability** - A consistent interface for performing operations irrespective of the underlying infrastructure and/or environment
 
-
 <hr/>
 
-
 ## Use cases
 
 
 ### Provisioning
 
-
-
 ### Day 2 Operations
 
-Day 2 operations can be added onto existing resources using `configs`, `components` or health `checks` using [resource selectors](/reference/resource-selector).
+Day 2 operations can be added onto existing resources (`configs`, `components` or health `checks`) using [resource selectors](/reference/resource-selector).
 
-For example Restarting a Kubernetes Deployment is only applicable to config items of type: `Kubernetes::Deployment`
+For example scaling a Kubernetes Deployment is only applicable to config items of type: `Kubernetes::Deployment`
 
-```yaml title="scale-deployment.yaml"
-#...
-kind: Playbook
-spec:
-  configs:
-    - types:
-        - Kubernetes::Deployment
-   #....
+```yaml title='scale-deployment.yaml' file=../../modules/mission-control/fixtures/playbooks/scale-deployment.yaml
 ```
 
-Before running a playbook, users can provide input using [`parameters`](/reference/playbooks/parameters)
-```yaml title="parameters.yaml"
-#...
-kind: Playbook
-spec:
-  # user input
-  parameters:
-    - name: replicas
-  # ...
+Before running a playbook, users can provide input using [`parameters`](/reference/playbooks/parameters).
+In the playbook above, the user can decide the new number of replicas before running the playbook.
 
-```
 
 ### Just In Time Access
 
 ### AIOps
 
-
-
-## Parameters
-
-Playbooks have 2 types of parameters:
-
-
-
-
-```yaml title="restrict-to-deployment.yaml"
-#...
-kind: Playbook
-spec:
-  # components: ...
-  # checks: ...
-  //highlight-next-line
-  configs:
-    - types:
-        - Kubernetes::Deployment
-```
-
-## Self-Service
-
-
-
-
-## Events
-
-## Webhooks
-
-
 ## Actions
 
 Playbooks execute a sequence of actions (steps), these actions can update git repositories, invoke pipelines or run command line tools like `kubectl` and `aws`.

mission-control/docs/playbooks/self-service.mdx

@@ -3,7 +3,7 @@ title: Self Service
 sidebar_position: 4
 ---
 
-import Parameters from '../reference/playbooks/parameters.md'
+import Parameters from '../reference/playbooks/parameters.mdx'
 
 Playbooks can be manually triggered on a component, config item or  check.
 

mission-control/docs/reference/playbooks/parameters.mdx

@@ -0,0 +1,137 @@
+---
+title: Parameters
+---
+
+```yaml title="scale-deployment.yaml" file=../../../modules/mission-control/fixtures/playbooks/scale-deployment.yaml
+
+```
+
+Playbook parameter defines a parameter that a playbook needs to run.
+
+<Fields withTemplates rows={[
+  {
+    field: "name",
+    description: "Name of parameter.",
+    scheme: "string",
+    required: true
+  },
+  {
+    field: "default",
+    description: "Default value of the parameter.",
+    scheme: "gotemplate",
+    templateEnv: [
+      {"name": "Context", "url": "/reference/playbooks/context"},
+    ]
+  },
+  {
+    field: "label",
+    description: "Label of the parameter.",
+    scheme: "string",
+  },
+  {
+    field: "required",
+    description: "Specify if the parameter is required.",
+    scheme: "bool",
+  },
+  {
+    field: "icon",
+    description: "Icon for the playbook.",
+    scheme: "Icon",
+  },
+  {
+    field: "description",
+    description: "A short sentence to describe the parameter. This shows up in the input form when running the playbook.",
+    scheme: "string",
+  },
+  {
+    field: "type",
+    description: "Type of parameter. (Defaults to \"text\")",
+    scheme: "[`Type`](#types)",
+  },
+  {
+    field: "properties",
+    description: "Properties of parameter. _Varies based on the type_",
+    scheme: "`map[string]string`",
+  }
+]} />
+
+## Defaulting
+
+Parameter values can be defaulted from the selected resource
+
+```yaml title="default parameters.yaml"
+#...
+kind: Playbook
+spec:
+  parameters:
+    // Use the config items type and name in the parameter
+    // highlight-next-line
+    - default: 'chore: update $(.config.type)/$(.config.name)'
+```
+
+When running the playbook on a `Deployment` named `mysql` the following is pre-populated:
+
+<img src="/img/parameter-defaulting.png" width="700px" className="border-1 border-solid border-gray-200"/>
+
+## Types
+
+| name         | Description                        | UI Component | Schema    | Properties                |
+| ------------ | ---------------------------------- | ------------ | --------- | ------------------------- |
+| `check`      | Limits the value to a check.       | Dropdown     | `string`  | [`Check`](#checks)        |
+| `checkbox`   | Boolean value toggle               | Checkbox     | `boolean` | -                         |
+| `code`       | Text area                          | Code Editor  | `string`  | [`Code`](#code)           |
+| `component`  | Limits the value to a component.   | Dropdown     | `string`  | [`Component`](#component) |
+| `config`     | Limits the value to a config item. | Dropdown     | `string`  | [`Config`](#config)       |
+| `list`       | Specify a custom list of values    | Dropdown     | `string`  | [`List`](#list)           |
+| `people`     | Limits the value to people.        | Dropdown     | `string`  | [`People`](#people)       |
+| `team`       | Limits the value to teams.         | Dropdown     | `string`  | -                         |
+| `text`       | Text input                         | Text Input   | `string`  | [`Text`](#text)           |
+| `millicores` | CPU resource                       | Number       | `string`  | -                         |
+| `bytes`      | Memory resource                    | Number       | `string`  | -                         |
+
+```yaml title='params-sink.yaml' file=../../../modules/mission-control/fixtures/playbooks/params.yaml {20,24,27,32,39,46,51,56,61,72} showLineNumbers
+
+```
+
+### component
+
+| Field      | Description                            | Schema                                             |
+| ---------- | -------------------------------------- | -------------------------------------------------- |
+| `filter[]` | Limit the components to these resources | [`ResourceSelector`](/reference/resource-selector) |
+
+### config
+
+| Field         | Description                              | Schema                                             |
+| ------------- | ---------------------------------------- | -------------------------------------------------- |
+| `filter[]` | Limit the config items to these resources | [`ResourceSelector`](/reference/resource-selector) |
+
+### checks
+
+| Field         | Description                        | Schema                                             |
+| ------------- | ---------------------------------- | -------------------------------------------------- |
+| `filter[]` | Limit the checks to these resources | [`ResourceSelector`](/reference/resource-selector) |
+
+### code
+
+| Field      | Description                       | Schema   |
+| ---------- | --------------------------------- | -------- |
+| `language` | e.g. `yaml`, `json`, `toml`, etc. | `string` |
+
+### people
+
+| Field  | Description                        | Schema  |
+| ------ | ---------------------------------- | ------- |
+| `role` | Limit the people to the given role | `string |
+
+### text
+
+| Field       | Description                 | Schema    |
+| ----------- | --------------------------- | --------- |
+| `multiline` | Render a multiline textarea | `boolean` |
+
+### list
+
+| Field             | Description                      | Schema   |
+| ----------------- | -------------------------------- | -------- |
+| `options[].label` | Specify label of the list option | `string` |
+| `options[].value` | Specify value of the list option | `string` |