From b5ff5d3489619b879a490e634ed2e45d4658942c Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Tue, 13 Oct 2020 16:13:21 +0200 Subject: [PATCH] Move context close to headings (#137) --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 433f8fc8d..0eccc719d 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,16 @@ For more details on a specific command, run `elastic-package help `. ### `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 @@ -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. @@ -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 @@ -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