Documentation improvement for creating your own beat #24660
Comments
|
Pinging @elastic/obs-docs (Team:Docs) |
2 tasks
cavokz
added a commit
that referenced
this issue
Apr 6, 2021
* Remove trailing whitespace * Fix 'make setup' instructions for a new beat In "Fetching Dependencies and Setting up the Beat" the user is instructed to run 'make setup' in the newly created beat directory. Such command fails with error: make: *** No rule to make target 'setup'. Stop. The problem and its fix are mentioned on forum [0] and reported in issue #24660. [0] https://discuss.elastic.co/t/make-no-rule-to-make-target-setup-stop-custom-beat/229231 * Correct 'make setup' also in generated docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the enhancement:
docs/devguide/newbeat.asciidoc
Improve documentation around creating custom beats. Specifically, using
make setupas described in our documentation here (relevant Github file) causes an error: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.
The text was updated successfully, but these errors were encountered: