Skip to content

Commit

Permalink
Move context close to headings (elastic#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
mtojek authored Oct 13, 2020
1 parent 24a6df1 commit b5ff5d3
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,16 @@ For more details on a specific command, run `elastic-package help <command>`.

### `elastic-package help`

_Context: global_

Use this command to get a listing of all commands available under `elastic-package` and a brief
description of what each command does.

_Context: global_


### `elastic-package build`

_Context: package_

Use this command to build a package. Built packages are stored in the `build/` folder located at the root folder of the local Git repository checkout that contains your package folder.

Built packages are served up by the Elastic Package Registry running locally (see
Expand All @@ -62,39 +64,37 @@ Elastic Package Registry, make sure to build that package _first_ using

Built packages can also be published to the `package-storage` repository.

_Context: package_


### `elastic-package check`

Use this command to run the `format`, `lint`, and `build` commands all at once, in that order.

_Context: package_

Use this command to run the `format`, `lint`, and `build` commands all at once, in that order.

### `elastic-package format`

Use this command to format the contents of a package.
### `elastic-package format`

_Context: package_

Use this command to format the contents of a package.


### `elastic-package lint`

_Context: package_

Use this command to validate the contents of a package using the
[package specification](https://github.com/elastic/package-spec).

_Context: package_


### `elastic-package promote`

_Context: global_

Use this command to promote packages from one stage of the Package Registry to another.

:warning: This command is intended primarily for use by administrators.

_Context: global_

#### GitHub authorization

The `promote` command requires access to the GitHub API to open pull requests or check authorized account data.
Expand All @@ -111,15 +111,17 @@ Make sure you have enabled the following scopes:

### `elastic-package stack`

_Context: global_

Use this command to spin up a Docker-based Elastic Stack consisting of Elasticsearch, Kibana, and
the Package Registry. By default the latest released version of the stack is spun up but it is possible
to specify a different version, including SNAPSHOT versions.

_Context: global_


### `elastic-package test`

_Context: package_

Use this command to run tests on a package. Currently, there are two types of tests available.

#### Pipeline Tests
Expand All @@ -134,16 +136,14 @@ These tests allow you to test a package's ability to ingest data end-to-end.

For details on how to configure amd run system tests, see the [HOWTO guide](docs/howto/system_testing.md).

_Context: package_


### `elastic-package version`

_Context: global_

Use this command to print the version of `elastic-package` that you have installed. This is
especially useful when reporting bugs.

_Context: global_


## Development

Expand Down

0 comments on commit b5ff5d3

Please sign in to comment.