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

Documentation improvements for "Generating Your Beat" #14509

Closed
liu-xiao-guo opened this issue Nov 14, 2019 · 4 comments
Closed

Documentation improvements for "Generating Your Beat" #14509

liu-xiao-guo opened this issue Nov 14, 2019 · 4 comments
Labels
docs enhancement :Generator Related to code generators for building custom Beats or modules. Stalled Team:Services (Deprecated) Label for the former Integrations-Services team

Comments

@liu-xiao-guo
Copy link

Describe the enhancement:
at the link https://www.elastic.co/guide/en/beats/devguide/7.5/newbeat-generate.html

  1. The {user} is not so clear. According to the context, "user" refers to the account name of github. it could be confused as the username on the local machine

  2. For some of the developers who have installed python3, virtualenv may not work properly, to fix that, we have to do:

export VIRTUALENV_PYTHON='/usr/local/bin/python'

where python refers to python 2.x

  1. We need to install mage at https://github.com/magefile/mage in order to make it work.
    python $GOPATH/src/github.com/elastic/beats/script/generate.py
    The above step is not needed

Describe a specific use case for the enhancement or feature:

@philippkahr
Copy link
Contributor

If you are having trouble with python like I did you could always use Vagrant, like I described there: #14148

There is an issue regarding moving python2 to python3 #5950

@jsoriano
Copy link
Member

Hey @liu-xiao-guo,

Python 2 is not required anymore (#14798), it'd be great if you could try how is the current experience with Python 3.

The {user} is not so clear. According to the context, "user" refers to the account name of github. it could be confused as the username on the local machine

Regarding this, current prompt mentions that the expected user name is the name of the github account. Do you have a proposal on how we could improve that?

Thanks for your feedback!

@jsoriano jsoriano added :Generator Related to code generators for building custom Beats or modules. docs enhancement Team:Services (Deprecated) Label for the former Integrations-Services team labels Feb 17, 2020
@jsoriano
Copy link
Member

cc @fearful-symmetry

@botelastic
Copy link

botelastic bot commented Jan 24, 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 the Stalled label Jan 24, 2021
@botelastic botelastic bot closed this as completed Feb 23, 2021
@zube zube bot removed the [zube]: Done label May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement :Generator Related to code generators for building custom Beats or modules. Stalled Team:Services (Deprecated) Label for the former Integrations-Services team
Projects
None yet
Development

No branches or pull requests

4 participants