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.

Sign up for GitHub

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

Jump to bottom

Update Developer Guide #1077

Closed
1 of 5 tasks
ruflin opened this issue Mar 1, 2016 · 4 comments
Closed
1 of 5 tasks

Update Developer Guide #1077

ruflin opened this issue Mar 1, 2016 · 4 comments
Labels
docs meta

Comments

@ruflin
Copy link
Member

ruflin commented Mar 1, 2016 •
edited by dedemorton
Loading

The developer guide needs an update that includes https://github.com/elastic/beat-generator

  • Document beat-generator and how to use it
  • Document on how to add a vendor library (remove .git folder)
  • Document recommendations for .editorconfig (how to use it)
  • Document on how to use travis
  • Document how fields.yml is used
@ruflin ruflin added the docs label Mar 1, 2016
@ruflin ruflin mentioned this issue Mar 1, 2016
Closed
@monicasarbu
Copy link
Contributor

I would include the beat-generator documentation under the Developer Guide: Creating a New Beat section. As of #1172, we need to update the developer guide anyway to replace Topbeat with some other simple beat.

@ruflin
Copy link
Member Author

ruflin commented Mar 18, 2016

Agree. For the guide I was thinking to take only the beat that is generated by beat-generator.

@monicasarbu
Copy link
Contributor

I think we should add a link to David's blog post about soundbeat as it describes the full experience of a Beat creator: http://david.pilato.fr/blog/2016/03/17/and-the-beats-go-on/

@monicasarbu monicasarbu changed the title Update Developer Guide Add beats-generator into Developer Guide Apr 21, 2016
@monicasarbu monicasarbu added the P1 label Apr 21, 2016
@monicasarbu monicasarbu changed the title Add beats-generator into Developer Guide Update Developer Guide May 19, 2016
@dedemorton dedemorton mentioned this issue Sep 7, 2016
Closed
50 tasks
@ruflin
Copy link
Member Author

ruflin commented Sep 16, 2016

Closing this issue as @kimjmin did a blog post (https://www.elastic.co/blog/build-your-own-beat) and the dev guide got updated accordingly.

@ruflin ruflin closed this as completed Sep 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs meta
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ruflin @monicasarbu