elastic / elastic/beats

[newbie-contributor] New contributor docs review — invalid Filebeat build path in dev setup

Open Beginner friendly
#49,810 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 1h
Merged PRs (30d)
370

Description

Summary

The main contributor setup guide contains a wrong path in its first build example. It instructs contributors to run cd beats/filebeat after cloning this repository, but in a fresh checkout that path does not exist.

Findings

1. Filebeat build example uses a non-existent directory

Where: docs/extend/index.md, section Setting Up Your Dev Environment, example under “Then you can compile a particular Beat by using Mage. For example, for Filebeat” (lines 59–64 in current repo)

Problem: The docs say:

cd beats/filebeat
mage build

From a fresh clone of this repo (.../github.com/elastic/beats), the valid directory is filebeat/, not beats/filebeat/.

Evidence: In this checkout, filebeat/ exists and beats/filebeat/ does not; attempting cd beats/filebeat from repo root fails.

Impact: This is a first-run command in the primary contributor onboarding flow (CONTRIBUTING.md links to this page). New contributors following the docs verbatim hit an immediate failure before their first build.

Suggested fix: Change the command to cd filebeat (or otherwise make the path consistent with the clone location shown earlier in the same guide).

Suggested Actions

  • Update docs/extend/index.md Filebeat build example to use the correct directory (filebeat).

[!NOTE]

🔒 Integrity filtering filtered 15 items

Integrity filtering activated and filtered the following items during workflow execution.
This happens when a tool call accesses a resource that does not meet the required integrity or secrecy level of the workflow.

  • #49678 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #48014 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #48902 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #36104 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #23575 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #1034 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #36629 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #33454 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #6296 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #11851 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #4750 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #2918 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #754 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • #722 (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)
  • issue:elastic/beats#unknown (search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".)

What is this? | From workflow: Docs New Contributor Review

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Apr 7, 2026, 2:42 PM UTC

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/extend/index.md and locate the “Setting Up Your Dev Environment” Filebeat example around lines 59–64. From the repository root, verify that filebeat/ exists and beats/filebeat/ does not, then confirm the corrected cd command is consistent with the clone location and allows the documented mage build command to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.