From 6c3c762704ddc1548fbca775dfc03b8ff8589031 Mon Sep 17 00:00:00 2001 From: Shaunak Kashyap Date: Wed, 7 Oct 2020 05:35:37 -0700 Subject: [PATCH] Minor fixes: typos and formatting (#129) * Removing outdated information * Moving context to correct place * Fixing links to anchors --- README.md | 7 ++++--- docs/howto/system_testing.md | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 818be8ca..f2b5dcdb 100644 --- a/README.md +++ b/README.md @@ -120,14 +120,12 @@ _Context: global_ ### `elastic-package test` -Use this command to run tests on a package. Currently, the only type of test that is supported are Pipeline Tests. +Use this command to run tests on a package. Currently, there are two types of tests available. #### Pipeline Tests These tests allow you to exercise any Ingest Node Pipelines defined by your packages. -_Context: package_ - #### System Tests These tests allow you to test a package's ability to ingest data end-to-end. @@ -136,6 +134,9 @@ These tests will spin up an Elasticsearch node, a Kibana instance, a Package Reg For details on how to configure system tests for a package, see the [HOWTO guide](docs/howto/system_testing.md). +_Context: package_ + + ### `elastic-package version` Use this command to print the version of `elastic-package` that you have installed. This is diff --git a/docs/howto/system_testing.md b/docs/howto/system_testing.md index 68205127..7f6cae2f 100644 --- a/docs/howto/system_testing.md +++ b/docs/howto/system_testing.md @@ -109,7 +109,7 @@ Placeholders used in the `config.yml` must be enclosed in `{{` and `}}` delimite Once the two levels of configurations are defined as described in the previous section, you are ready to run system tests for a package's data streams. -First you must deploy the Elastic Stack. This corresponds to steps 1 and 2 as described in the [_Conceptual process_](#Conceptual_process) section. +First you must deploy the Elastic Stack. This corresponds to steps 1 and 2 as described in the [_Conceptual process_](#Conceptual-process) section. ``` elastic-package stack up -d @@ -123,7 +123,7 @@ Next, you must set environment variables needed for further `elastic-package` co $(elastic-package stack shellinit) ``` -Next, you must invoke the system tests runner. This corresponds to steps 3 through 7 as described in the [_Conceptual process_](#Conceptual_process) section. +Next, you must invoke the system tests runner. This corresponds to steps 3 through 7 as described in the [_Conceptual process_](#Conceptual-process) section. If you want to run system tests for **all data streams** in a package, navigate to the package's root folder (or any sub-folder under it) and run the following command.