Documentation update

CODE_OF_CONDUCT.md

@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement via the [Gitter chat](https://gitter.im/HewlettPackard/squest).
+reported to the community leaders responsible for enforcement via the [Gitter chat](https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im).
 
 All complaints will be reviewed and investigated promptly and fairly.
 

README.md

@@ -6,7 +6,7 @@
 
 <p align="center">
 <a href="https://hewlettpackard.github.io/squest/latest"><img alt="Doc" src="https://img.shields.io/badge/read-documentation-1abc9c?style=flat-square"></a>
-<a href="https://gitter.im/HewlettPackard/squest"><img alt="Gitter" src="https://img.shields.io/gitter/room/HewlettPackard/squest?color=1abc9c&style=flat-square"></a>
+<a href="https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im"><img alt="Gitter" src="https://img.shields.io/gitter/room/HewlettPackard/squest?color=1abc9c&style=flat-square"></a>
 <a href= "https://coveralls.io/github/HewlettPackard/squest"><img alt="Coveralls" src="https://img.shields.io/coveralls/github/HewlettPackard/squest?style=flat-square"></a>
 <a href="https://github.com/HewlettPackard/squest/releases/latest"><img alt="GitHub release (latest)" src="https://img.shields.io/github/v/release/HewlettPackard/squest?style=flat-square"></a>
 <a href="https://github.com/HewlettPackard/squest/blob/master/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/HewlettPackard/squest?style=flat-square"></a>
@@ -50,7 +50,7 @@ If you want an idea of what you can do with Squest, click on the image below.
 ## Links
 
 :blue_book: [Documentation](https://hewlettpackard.github.io/squest/latest)<br/>
-:speech_balloon: [Chat on Gitter](https://gitter.im/HewlettPackard/squest)<br/>
+:speech_balloon: [Chat on Gitter](https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im)<br/>
 :movie_camera: [Demo video](https://youtu.be/mQnNkSMMXwg)<br/>
 :monkey_face: [Our Ansible playbook testing framework](https://github.com/HewlettPackard/monkeyble)
 

docs/dev/release.md

@@ -29,4 +29,4 @@ From here the CI will:
   - Update poetry version in `pyproject.toml` with new beta version (E.g: `1.8.3b`)
   - Bump poetry libraries
   - Force push the new dev branch to upstream
-- Notify community in [Gitter](https://gitter.im/HewlettPackard/squest)
+- Notify community in [Gitter](https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im)

docs/index.md

@@ -9,6 +9,6 @@
 Squest is a self-service portal that works on top of Red Hat Ansible Automation Platform/AWX.
 
 - Follow the [installation guide](getting_started.md) to get your own deployment up and running
-- A [Gitter Chat](https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im) is available if you want to discuss with the developers or the community
+- Discuss with developers or the community on [Gitter Chat](https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im)
 - Check out our [GitHub repository](https://github.com/HewlettPackard/squest) if you are interested into contributing to Squest
 - Don't hesitate to [raise an issue](https://github.com/HewlettPackard/squest/issues) to propose new features or raise a bug

docs/manual/administration/approval_workflow.md

@@ -36,12 +36,13 @@ Steps are the breakpoint of a Squest request. Each step need to be accepted in o
 
 Configuration:
 
-| Name            | Description                                                                                                        |
-|-----------------|--------------------------------------------------------------------------------------------------------------------|
-| Name            | Unique identifier of the _Step_                                                                                    |
-| Permission      | Permission required to be allowed to accept or reject the request. By default set to `approve_reject_approvalstep` |
-| Readable field  | Field from the survey that will be shown in the form but cannot be updated in the step                             |
-| Editable  field | Field from the survey that can be filled or updated from a previous step                                           |
+| Name                  | Description                                                                                                        |
+|-----------------------|--------------------------------------------------------------------------------------------------------------------|
+| Name                  | Unique identifier of the _Step_                                                                                    |
+| Permission            | Permission required to be allowed to accept or reject the request. By default set to `approve_reject_approvalstep` |
+| Readable field        | Field from the survey that will be shown in the form but cannot be updated in the step                             |
+| Editable  field       | Field from the survey that can be filled or updated from a previous step                                           |
+| Auto accept condition | An Ansible "when" like that enable auto accept on a Step (see below)                                               |
 
 !!! warning
 

docs/manual/advanced/filters.md

@@ -1,5 +1,7 @@
 # JSON Accessor
 
+In the Squest UI, certain pages offer filtering options based on JSON accessors. For instance, the instance list page allows filtering based on instance specs.
+
 To access a field in json, simply describe the path by separating the levels by dots. The value of field to filter
 must be after an equal. It is possible to make a filter on several fields which are separated by commas.
 
@@ -9,49 +11,49 @@ must be after an equal. It is possible to make a filter on several fields which
 
 ```json
 {
-  "my_first_field": "my_value"
+  "vm_name": "vm001"
 }
 ```
 
 Examples of lookup string that can be used in the filter.
 
 ```
-my_first_field=my_value
-my_first_field='my_value'
-my_first_field="my_value"
+vm_name=vm001
+vm_name='vm001'
+vm_name="vm001"
 ```
 
 ### Instance spec with dict
 
 ```json
 {
-  "my_first_field": {
-    "my_second_field": "my_value"
+  "openstack": {
+    "cluster_name": "cluster_perf"
   }
 }
 ```
 
 Example of lookup string that can be used in the filter.
 
 ```
-my_first_field.my_second_field=my_value
+openstack.cluster_name=cluster_perf
 ```
 
 ### Instance spec with list
 
 ```json
 {
-  "my_first_field": [
-    "my_value1",
-    "my_value2"
+  "vm_disk": [
+    "disk01",
+    "disk02"
   ]
 }
 ```
 
 Example of lookup string that can be used in the filter.
 
 ```
-my_first_field.0=my_value1
+vm_disk.0=disk01
 ```
 
 ### Instance spec on two fields

docs/manual/advanced/jinja.md

@@ -1,6 +1,7 @@
 # Jinja templating
 
-[Jinja templating](https://jinja.palletsprojects.com/en/3.1.x/templates/) can be used in some part of the Squest configuration.
+[Jinja templating](https://jinja.palletsprojects.com/en/3.1.x/templates/) is applicable within specific sections of the
+Squest configuration. For example, Jinja templating enables the prefilling of a survey field for a day 2 operations using the specs of the instance.
 
 Jinja templating usage with `{{ instance }}` as context:
 

docs/manual/advanced/validators.md

@@ -1,6 +1,6 @@
 # Field validators
 
-Field validators are python modules that can be added as plugin to perform a custom check on a form field.
+Field validators are Python modules that can be added as plugin to perform custom checks on an [operation survey field](../service_catalog/operation.md#survey).
 
 ## Create a field validator
 

docs/manual/resource_tracking/concept.md

@@ -36,7 +36,7 @@ Starting from the previous state, we can then create a _Resource Group_ for virt
 
 If we want to add more VMs that **consume** resources from the "cluster" _Resource Group_, we need to be sure we have enough physical servers (resources) that **produce** into it.  
 
-### Namespace tracking example
+### Kubernetes tracking example
 
 In this example we want to track the consumption of an orchestrator of container like Kubernetes or Openshift. 
 Namespaces (or projects in Openshift world) are a way to divide cluster resources between multiple users by using 

docs/manual/service_catalog/operation.md

@@ -115,7 +115,7 @@ See related [documentation here](../advanced/validators.md).
 
 ### Attribute definition
 
-Each field can be linked to an _Attribute definition_ from the resource tracking. This allows to automatically limit the field value to a quota.
+Each field can be linked to an _Attribute definition_ from the resource tracking. This allows to automatically limit the field value to a [quota](../access.md#quota).
 The available quota is shown in the form of the request so the end user know what he can still consume.
 
 ![survey_quota](../../images/survey_quota.png)

docs/release_notes.md

@@ -13,6 +13,8 @@ This is a **major** update of Squest:
 
 - The resource tracker component has been entirely refactored and cannot be migrated automatically
 - The API has been reworked
+- The previous team feature has been discontinued and replaced by an Organization/Team feature. Please note that old
+  teams data will be lost
 
 To migrate from v1 to v2 if you were using the **resource tracking** feature:
 

templates/base.html

@@ -115,7 +115,7 @@
                     API</a>
                 <a class="text-secondary" href="https://github.com/HewlettPackard/squest"><i class="fas fa-code"></i>
                     Code</a>
-                <a class="text-secondary" href="https://gitter.im/HewlettPackard/squest"><i class="fas fa-comments"></i>
+                <a class="text-secondary" href="https://app.gitter.im/#/room/#HewlettPackard_squest:gitter.im"><i class="fas fa-comments"></i>
                     Squest community chat</a>
             </div>