Skip to content

Edit CLI help for Elastic Agent #139

Open

Description

The help panel accessed with --help has some typos and inconsistencies:

  • Start and run a Fleet Server along side this Elastic Agent connecting to the provided elasticsearch

    Saying "start and run" is redundant and perhaps misleading. This is draft text (needs a review), but we want to change this to something like:

    "Start a Fleet Server process when Elastic Agent is started, and connect to the specified Elasticsearch URL"

  • Path to certificate authority to use with communicate with elasticsearch

    Change to: "Path to certificate authority to use to communicate with Elasticsearch"

  • Start and run a Fleet Server on this specific policy

    Change to something like: "Start a Fleet Server process when Elastic Agent is started, and use the specified policy"

  • URL of Fleet-Server to enroll Agent into Fleet-Server (deprecated)

    We are inconsistent in how we refer to Fleet Server. Change to:

    "Fleet Server URL to use to enroll the Elastic Agent into Fleet (deprecated)"

  • We are also inconsistent wrt how we refer to the Elastic Agent. We use Agent, agent, and Elastic Agent. To avoid the weirdness around capitalizing agent, maybe we should always say Elastic Agent unless it becomes repetitive in a single sentence, in which case, we should use "agent" (lowercase).

  • Init cap every description.

This review is not complete. A writer should go through all the text and make it consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions