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

Beats developer guide needs to describe how to install mage #14409

Closed
dedemorton opened this issue Nov 7, 2019 · 5 comments
Closed

Beats developer guide needs to describe how to install mage #14409

dedemorton opened this issue Nov 7, 2019 · 5 comments
Labels
bug devguide docs needs_team Indicates that the issue/PR needs a Team:* label Stalled

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Nov 7, 2019

Contributors' guide needs to be updated with instructions (or pointers to instructions) about installing mage.

We currently have mage as a dependency, but don't describe how to install it.

@dedemorton
Copy link
Contributor Author

Also need to tell users to run mage GenerateCustomBeat from the beats directory

@philippkahr
Copy link
Contributor

Hi @dedemorton
I experienced the same issue when I started contributing to beats. I just started with Go and thus GOPATH and so on was not very clear. Maybe we should not only point to a direction where someone has a guide but instead, generate a little shell script that prepares your machine? Maybe also point out how to use vagrant to have a fully recreate able testing and developing environment. #14148

I already started an issue about the contributing guidelines and found a meta issue. I think those should be linked.
#14260
#11102

@bestpath-gb
Copy link
Contributor

Also need to tell users to run mage GenerateCustomBeat from the beats directory

I've just opened a PR to address that problem but not the requirement to add instructions for installing Mage.

@botelastic
Copy link

botelastic bot commented Mar 18, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@botelastic botelastic bot added Stalled needs_team Indicates that the issue/PR needs a Team:* label labels Mar 18, 2021
@botelastic
Copy link

botelastic bot commented Mar 18, 2021

This issue doesn't have a Team:<team> label.

@botelastic botelastic bot closed this as completed Apr 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug devguide docs needs_team Indicates that the issue/PR needs a Team:* label Stalled
Projects
None yet
Development

No branches or pull requests

3 participants