Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fix 'make setup' instructions for a new beat #24944

Merged
merged 3 commits into from
Apr 6, 2021
Merged

[DOCS] Fix 'make setup' instructions for a new beat #24944

merged 3 commits into from
Apr 6, 2021

Conversation

cavokz
Copy link
Contributor

@cavokz cavokz commented Apr 6, 2021

What does this PR do?

Fix the instructions to create a new beat, as written in "Fetching Dependencies and Setting up the Beat".

Why is it important?

Following the instructions results in an error message and the user is unable to continue.

Checklist

  • My code follows the style guidelines of this project
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] I have made corresponding change to the default configuration files
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 6, 2021
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
@elasticmachine
Copy link
Collaborator

elasticmachine commented Apr 6, 2021

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Pull request #24944 updated

  • Start Time: 2021-04-06T13:01:31.439+0000

  • Duration: 23 min 55 sec

  • Commit: 64a967f

Trends 🧪

Image of Build Times

❕ Flaky test report

No test was executed to be analysed.

@cavokz cavokz changed the title Fix 'make setup' instructions for a new beat [DOCS] Fix 'make setup' instructions for a new beat Apr 6, 2021
@fearful-symmetry fearful-symmetry added the Team:Integrations Label for the Integrations team label Apr 6, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 6, 2021
@fearful-symmetry fearful-symmetry requested a review from a team April 6, 2021 15:09
Copy link
Contributor

@fearful-symmetry fearful-symmetry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM.

@cavokz cavokz merged commit 079d16b into elastic:master Apr 6, 2021
@cavokz cavokz deleted the fix_make_setup branch April 6, 2021 15:35
v1v added a commit to v1v/beats that referenced this pull request Apr 7, 2021
* upstream/master: (91 commits)
  [Filebeat] Change okta.target to nested field (elastic#24636)
  Add RFC5424 format support for syslog input  (elastic#23954)
  Fix links to Beats product pages (elastic#24821)
  [DOCS] Fix 'make setup' instructions for a new beat (elastic#24944)
  Remove duplicate decode_xml entry (elastic#24941)
  [libbeat] Add wineventlog schema to decode_xml processor (elastic#24726)
  [Elastic Agent] Add check for URL set when cert and cert key. (elastic#24904)
  feat: stage execution cache (elastic#24780)
  Fix error in Journalbeat commands (elastic#24880)
  Add baseline ECS 1.9.0 upgrade (elastic#24909)
  [Elastic Agent] Cloud container legacy apm files. (elastic#24896)
  [Elastic Agent]: Reduce allowed socket path length (elastic#24914)
  Add ability to destroy indices with wildcards in testing (elastic#24915)
  Add status subcommand to report status of running daemon. (elastic#24856)
  Fix types of fields GetHits and Ops in Metricbeat module for Couchbase (elastic#23287)
  Add support for Filestream input in elastic agent. (elastic#24820)
  Implement k8s secrets provider for Agent (elastic#24789)
  Sort processor list in docs (elastic#24874)
  Add support for SCRAM authentication in kafka metricbeat module (elastic#24810)
  Properly update offset in case of unparasable line (elastic#22685)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug docs Team:Integrations Label for the Integrations team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation improvement for creating your own beat
3 participants