Docs: use a simple clone in the New Beat guide #6786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous version used `go get` as a trick to clone the repository in the correct path. However: * the extra magic can be confusing * the `go get` results in an error (no buildable Go files). The docs were telling the reader to ignore the error, but it seems the wording of the error is different now. I think it's better to use a simple `git clone`, which is what we use also in the main Contributing guide.
tsg
added
docs
needs_backport
ruflin
reviewed
Apr 6, 2018
|
|
||
| [source,shell] | ||
| ---------------------------------------------------------------------- | ||
| go get github.com/elastic/beats | ||
| mkdir -p ${GOPATH}/src/github.com/elastic |
There was a problem hiding this comment.
I remember this being our initial version but people struggled with setting the GOPATH. Now that since the more recent golang versions have a predefined go path, this should be less of an issue.
dedemorton
pushed a commit
to dedemorton/beats
that referenced
this pull request
May 2, 2018
The previous version used `go get` as a trick to clone the repository in the correct path. However: * the extra magic can be confusing * the `go get` results in an error (no buildable Go files). The docs were telling the reader to ignore the error, but it seems the wording of the error is different now. I think it's better to use a simple `git clone`, which is what we use also in the main Contributing guide.
dedemorton
removed
the
needs_backport
ruflin
pushed a commit
that referenced
this pull request
May 3, 2018
The previous version used `go get` as a trick to clone the repository in the correct path. However: * the extra magic can be confusing * the `go get` results in an error (no buildable Go files). The docs were telling the reader to ignore the error, but it seems the wording of the error is different now. I think it's better to use a simple `git clone`, which is what we use also in the main Contributing guide.
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
The previous version used `go get` as a trick to clone the repository in the correct path. However: * the extra magic can be confusing * the `go get` results in an error (no buildable Go files). The docs were telling the reader to ignore the error, but it seems the wording of the error is different now. I think it's better to use a simple `git clone`, which is what we use also in the main Contributing guide.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The previous version used
go getas a trick to clone the repositoryin the correct path. However:
go getresults in an error (no buildable Go files). The docswere telling the reader to ignore the error, but it seems the wording
of the error is different now.
I think it's better to use a simple
git clone, which is what weuse also in the main Contributing guide.