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

Update CONTRIBUTING.md (cherry-pick #2263 into 5.0) #2273

Merged
merged 1 commit into from
Aug 16, 2016
Merged

Update CONTRIBUTING.md (cherry-pick #2263 into 5.0) #2273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,6 @@ The Beats are Go programs, so install the latest version of
[golang](http://golang.org/) if you don't have it already. The current Go version
used for development is Golang 1.6.2.

The Beats are Go programs, so install the latest version of
[golang](http://golang.org/) if you don't have it already.

The location where you clone is important. Please clone under the source
directory of your `GOPATH`. If you don't have `GOPATH` already set, you can
simply set it to your home directory (`export GOPATH=$HOME`).
Expand All @@ -70,13 +67,13 @@ Packetbeat:
$ cd beats/packetbeat
$ make

Some of the Beats might have extra development requirements, in which case a
CONTRIBUTING.md file is find in the Beat directory.
Some of the Beats might have extra development requirements, in which case you'll find a
Copy link
Collaborator

Choose a reason for hiding this comment

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

As packetbeat is the only one with a local file, we should probably remove it in the future and here link to a general developer guide which then links to packetbeat dev guide. This again points in the direction that all dev guide should leave in on place (@urso ;-) ).

CONTRIBUTING.md file in the Beat directory.

## Update scripts

The beats use a variety of scripts based on python to generate configuration files
and documentations. The command used for this is:
The Beats use a variety of scripts based on Python to generate configuration files
and documentation. The command used for this is:

$ make update

Expand All @@ -86,7 +83,7 @@ This command has the following dependencies:
* [virtualenv](https://virtualenv.pypa.io/en/latest/) for Python

Virtualenv can be installed with the command `easy_install virtualenv` or `pip install virtualenv`.
More details can be [here](https://virtualenv.pypa.io/en/latest/installation.html).
More details can be found [here](https://virtualenv.pypa.io/en/latest/installation.html).


## Testing
Expand All @@ -104,10 +101,10 @@ Running the testsuite has the following requirements:

## Documentation

The documentation for each beat can be found in {beatname}/docs and are based on asciidoc. After every change of the
docs it should be verified that the docs are still building to not break the automated docs build. To build the docs
run `make docs`. In case you want to preview the docs for a beat, run `make docs-preview` inside the beats folder.
This will automatically open your browser with the docs for preview.
The documentation for each Beat is located under {beatname}/docs and is based on asciidoc. After changing the docs,
you should verify that the docs are still building to avoid breaking the automated docs build. To build the docs run
`make docs`. If you want to preview the docs for a specific Beat, run `make docs-preview`
inside the folder for the Beat. This will automatically open your browser with the docs for preview.


## Dependencies
Expand Down