From 135314fdc2ede0cfcc42d62a40fd9edee934a531 Mon Sep 17 00:00:00 2001
From: Gabriel Dantas <gabriel.dantas98@outlook.com.br>
Date: Thu, 27 Oct 2022 09:46:28 -0300
Subject: [PATCH] docs: scaffolder inputs examples

Signed-off-by: Gabriel Dantas <gabriel.dantas98@outlook.com.br>
---
 .../software-templates/inputs-examples.md     | 198 ++++++++++++++++++
 mkdocs.yml                                    |   1 +
 2 files changed, 199 insertions(+)
 create mode 100644 docs/features/software-templates/inputs-examples.md

diff --git a/docs/features/software-templates/inputs-examples.md b/docs/features/software-templates/inputs-examples.md
new file mode 100644
index 0000000000..dbaab6b144
--- /dev/null
+++ b/docs/features/software-templates/inputs-examples.md
@@ -0,0 +1,198 @@
+---
+id: inputs-examples
+title: Built-in examples inputs
+description: Some examples to use in your template
+---
+
+All the examples on this page you can test using _create/edit_ from your Backstage installation.
+
+It is important to remember that all examples are based on [react-jsonschema-form](https://rjsf-team.github.io/react-jsonschema-form/).
+
+# Simple text input
+
+## Simple input with basic validations
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      name:
+        title: Simple text input
+        type: string
+        description: Description about input
+        maxLength: 8
+        pattern: '^([a-zA-Z][a-zA-Z0-9]*)(-[a-zA-Z0-9]+)*$'
+        ui:autofocus: true
+        ui:help: "Hint: additional description..."
+```
+
+## Simple secret input
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      secretInput:
+        title: Input secret
+        type: string
+        description: Super secret description hint
+        minLength: 6
+        ui:widget: "password"
+```
+
+## Multi line text input
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      multiline:
+        title: Text area input
+        type: string
+        description: Insira o valor do input que gostraia
+        ui:widget: "textarea"
+        ui:options: 
+          rows: 10
+        ui:help: "Hint: Make it strong!"
+        ui:placeholder: |
+          apiVersion: backstage.io/v1alpha1
+            kind: Component
+            metadata:
+              name: backstage
+            spec:
+              type: library
+              owner: CNCF
+              lifecycle: experimental
+```
+
+# Arrays options
+
+## Enum with custom titles
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      volume_type:
+        title: Volume Type
+        type: string
+        description: The volume type to be used.
+        enum: ['gp2', 'gp3', 'io1', 'io2', 'sc1', 'st1', 'standard']
+        default: 'gp2'
+        enumNames:
+          [
+            'General Purpose SSD (gp2)',
+            'General Purpose SSD (gp3)',
+            'Provisioned IOPS (io1)',
+            'Provisioned IOPS (io2)',
+            'Cold HDD (sc1)',
+            'Throughput Optimized HDD (st1)',
+            'Magnetic (standard)',
+          ]
+```
+
+## A multiple choices list
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      name:
+        title: Select environments
+        type: array
+        items:
+          type: string
+          enum: ["production", "staging", "development"]
+        uniqueItems: true
+        ui:widget: checkboxes
+```
+
+## Array with another types
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      arrayObjects:
+        title: Array with custom objects
+        type: array
+        ui:options:
+          addable: false
+          orderable: false
+          removable: false
+        items:
+          type: object
+          properties:
+            array:
+              title: Array string with default value
+              type: string
+              default: value3
+              enum:
+                - value1
+                - value2
+                - value3
+            flag:
+              title: Boolean flag
+              type: boolean
+              ui:widget: radio
+            someInput:
+              title: Simple text input
+              type: string
+```
+
+# Boolean options
+
+## Boolean
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      name:
+        title: Checkbox boolean
+        type: boolean
+```
+
+## Boolean Yes or No options
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      name:
+        title: Yes or No options
+        type: boolean
+        ui:widget: radio
+```
+
+## Boolean multiple options
+
+```yaml
+parameters:
+  - title: Fill in some steps
+    properties:
+      name:
+        title: Select features
+        type: array
+        items:
+          type: boolean
+          enum: ["Enable scraping", "Enable HPA", "Enable cache"]
+        uniqueItems: true
+        ui:widget: checkboxes
+```
+
+## Use parameters as condition in steps
+
+```yaml
+- name: Only development environments
+  if: ${{ parameters.environment === "staging" and parameters.environment === "development" }}
+  action: debug:log
+  input:
+    message: "development step"
+
+- name: Only production environments
+  if: ${{ parameters.environment === "prod" or parameters.environment === "production" }}
+  action: debug:log
+  input:
+    message: "production step"
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 43efc32f8e..d7f303649c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -61,6 +61,7 @@ nav:
           - Overview: 'features/software-templates/index.md'
           - Configuration: 'features/software-templates/configuration.md'
           - Adding your own Templates: 'features/software-templates/adding-templates.md'
+          - Inputs examples: 'features/software-templates/inputs-examples.md'
           - Writing Templates: 'features/software-templates/writing-templates.md'
           - Builtin Actions: 'features/software-templates/builtin-actions.md'
           - Writing Custom Actions: 'features/software-templates/writing-custom-actions.md'