Update docs to standardize examples (#122)

djaglowski · Apr 27, 2021 · 0a6d699 · 0a6d699
1 parent d73dd05
commit 0a6d699
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 6 deletions.
diff --git a/docs/operators/add.md b/docs/operators/add.md
@@ -14,7 +14,7 @@ The `add` operator adds a value to an `entry`'s `body`, `attributes`, or `resour
 | `if`       |                  | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |
 
 
-Example usage:
+### Example Configurations:
 
 <hr>
 Add a string to the body

diff --git a/docs/operators/copy.md b/docs/operators/copy.md
@@ -13,7 +13,7 @@ The `copy` operator copies a value from one [field](/docs/types/field.md) to ano
 | `on_error` | `send`           | The behavior of the operator if it encounters an error. See [on_error](/docs/types/on_error.md)                                                                                                                                          |
 | `if`       |                  | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |
 
-Example usage:
+### Example Configurations:
 
 <hr>
 Copy a value from the body to resource

diff --git a/docs/operators/flatten.md b/docs/operators/flatten.md
@@ -13,7 +13,7 @@ The operator only flattens a single level deep.
 | `on_error` | `send`           | The behavior of the operator if it encounters an error. See [on_error](/docs/types/on_error.md)                                                                                                                                          |
 | `if`       |                  | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |
 
-Example usage:
+### Example Configurations:
 
 <hr>
 Flatten an object to the base of the body

diff --git a/docs/operators/move.md b/docs/operators/move.md
@@ -13,7 +13,7 @@ The `move` operator moves (or renames) a field from one location to another.
 | `on_error` | `send`           | The behavior of the operator if it encounters an error. See [on_error](/docs/types/on_error.md)                                                                                                                                          |
 | `if`       |                  | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |
 
-Example usage:
+### Example Configurations:
 
 Rename value
 ```yaml

diff --git a/docs/operators/remove.md b/docs/operators/remove.md
@@ -12,7 +12,7 @@ The `remove` operator removes a field from a record.
 | `on_error` | `send`           | The behavior of the operator if it encounters an error. See [on_error](/docs/types/on_error.md)                                                                                                                                          |
 | `if`       |                  | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. |
 
-Example usage:
+### Example Configurations:
 
 <hr>
 

diff --git a/docs/operators/retain.md b/docs/operators/retain.md
@@ -14,7 +14,9 @@ The `retain` operator keeps the specified list of fields, and removes the rest.
 <hr>
 <b>NOTE:</b> If no fields in a group (attributes, resource, or body) are specified, that entire group will be retained.
 <hr>
-Example usage:
+
+### Example Configurations:
+
 <hr>
 Retain fields in the body