Skip to content

Commit

Permalink
Minor fixes: typos and formatting (elastic#129)
Browse files Browse the repository at this point in the history
* Removing outdated information

* Moving context to correct place

* Fixing links to anchors
  • Loading branch information
ycombinator authored Oct 7, 2020
1 parent 16795cf commit 6c3c762
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/howto/system_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit 6c3c762

Please sign in to comment.