Improve documentation for system tests (#249)

* Fix: describe test-default-config.yml * Hint
elastic · Feb 16, 2021 · e481ad2 · e481ad2
1 parent f8106b6
commit e481ad2
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/docs/howto/system_testing.md b/docs/howto/system_testing.md
@@ -120,7 +120,9 @@ Notice the use of the `TEST_RUN_ID` variable. It contains a unique ID, which can
 
 ### Test case definition
 
-Next, we must define configuration for each data stream that we want to system test.
+Next, we must define at least one configuration for each data stream that we want to system test. There can be multiple test cases defined for the same data stream.
+
+_Hint: if you plan to define only one test case, you can consider the filename `test-default-config.yml`._
 
 ```
 <package root>/
@@ -129,10 +131,10 @@ Next, we must define configuration for each data stream that we want to system t
       _dev/
         test/
           system/
-            config.yml
+            test-<test_name>-config.yml
 ```
 
-The `config.yml` file allows you to define values for package and data stream-level variables. For example, the `apache/access` data stream's `config.yml` is shown below.
+The `test-<test_name>-config.yml` file allows you to define values for package and data stream-level variables. For example, the `apache/access` data stream's `test-access-log-config.yml` is shown below.
 
 ```
 vars: ~
@@ -154,7 +156,7 @@ whose input type matches the `input` value will be tested. By default, the first
 
 #### Placeholders
 
-The `SERVICE_LOGS_DIR` placeholder is not the only one available for use in a data stream's `config.yml` file. The complete list of available placeholders is shown below.
+The `SERVICE_LOGS_DIR` placeholder is not the only one available for use in a data stream's `test-<test_name>-config.yml` file. The complete list of available placeholders is shown below.
 
 | Placeholder name | Data type | Description |
 | --- | --- | --- |
@@ -164,7 +166,7 @@ The `SERVICE_LOGS_DIR` placeholder is not the only one available for use in a da
 | `Logs.Folder.Agent` | string | Path to integration service's logs folder, as addressable by the Agent. |
 | `SERVICE_LOGS_DIR` | string | Alias for `Logs.Folder.Agent`. Provided as a convenience. |
 
-Placeholders used in the `config.yml` must be enclosed in `{{` and `}}` delimiters, per Handlebars syntax.
+Placeholders used in the `test-<test_name>-config.yml` must be enclosed in `{{` and `}}` delimiters, per Handlebars syntax.
 
 ## Running a system test