Skip to content

Commit

Permalink
[DOCS] Fix 'make setup' instructions for a new beat (#24944)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
cavokz authored Apr 6, 2021
1 parent 22baef4 commit 079d16b
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Fix ILM alias not being created if `setup.ilm.check_exists: false` and `setup.ilm.overwrite: true` has been configured. {pull}24480[24480]
- Fix issue discovering docker containers and metadata after reconnections {pull}24318[24318]
- Allow cgroup self-monitoring to see alternate `hostfs` paths {pull}24334[24334]
- Fix 'make setup' instructions for a new beat {pull}24944[24944]

*Auditbeat*

Expand Down
6 changes: 3 additions & 3 deletions docs/devguide/newbeat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ For the `github_name`, enter your github id. The `beat` and `beat_path` are set
---------
Enter a project name [examplebeat]: Countbeat
Enter a github name [your-github-name]: {username}
Enter a beat path [github.com/{username}/countbeat]:
Enter a beat path [github.com/{username}/countbeat]:
Enter a full name [Firstname Lastname]: {Full Name}
Enter the github.com/elastic/beats revision [master]:
---------
Expand All @@ -162,7 +162,7 @@ To fetch dependencies and set up the Beat, run:
[source,shell]
---------
cd ${GOPATH}/src/github.com/{user}/countbeat
make setup
make update
---------

The Beat now contains the basic config file, `countbeat.yml`, and template files. The Beat is "complete" in the sense
Expand Down Expand Up @@ -340,7 +340,7 @@ countbeat:

- `period`: Defines how often to send out events

The config file is generated when you run `make setup` to <<setting-up-beat,set up the beat>>. The file contains
The config file is generated when you run `make update` to <<setting-up-beat,set up the beat>>. The file contains
basic configuration information. To add configuration options to your Beat, you need to update the Go structures in
`config/config.go` and add the corresponding config options to `_meta/beat.yml`.

Expand Down
2 changes: 1 addition & 1 deletion generator/_templates/beat/{beat}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To get running with {Beat} and also install the
dependencies, run the following command:

```
make setup
make update
```

It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.
Expand Down
2 changes: 1 addition & 1 deletion generator/_templates/metricbeat/{beat}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
To get started run the following command. This command should only be run once.

```
make setup
make update
```

It will ask you for the module and metricset name. Insert the name accordingly.
Expand Down
2 changes: 1 addition & 1 deletion x-pack/osquerybeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To get running with {Beat} and also install the
dependencies, run the following command:

```
make setup
make update
```

It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.
Expand Down

0 comments on commit 079d16b

Please sign in to comment.