Skip to content

Documentation improvement for creating your own beat #24660

@robb3rt

Description

@robb3rt

Describe the enhancement:
docs/devguide/newbeat.asciidoc
Improve documentation around creating custom beats. Specifically, using make setup as described in our documentation here (relevant Github file) causes an error:

pi@pitest:~/go/src/github.com/robb3rt/stonksbeat $ make setup
make: *** No rule to make target 'setup'.  Stop.

Following through the documentation it seems that the configuration files have already been created, so perhaps this step is no longer necessary? I don't know for sure by following the documentation alone.

It would be nice if the document can clarify if this is expected or to update this document in case anything has changed in the process. It would also be nice if the document can go more into detail about what the template files are? I don't see that being linked to any examples, unlike the configuration files are.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions