Update generator docs to use specific version #3197
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
ruflin
commented
Dec 15, 2016
| [source,bash] | ||
| ---- | ||
| cd $GOPATH/src/github.com/elastic/beats | ||
| git checkout 5.1 |
There was a problem hiding this comment.
we could you {doc_branch} here but that will not work in the docs above which are also shown on Github. We have to find some simplification here in the future.
ruflin
added
the
needs_backport
|
This change needs backport to 5.0 and 5.1 |
ruflin
added
in progress
ruflin
force-pushed
the
generator-version-update
branch
from
aea1299 to
45f53fd
Compare
ruflin
commented
Dec 16, 2016
| [source,bash,,subs="attributes"] | ||
| ---- | ||
| cd $GOPATH/src/github.com/elastic/beats | ||
| git checkout {doc-branch} |
There was a problem hiding this comment.
@dedemorton I tried sub="attributes" here so the variable gets replaced. This does not seem to work. If I leave out one , I get a different error. Any idea on how this is best done?
There was a problem hiding this comment.
Try this instead: ["source","sh",subs="attributes"]
There was a problem hiding this comment.
That seems to work. Thanks.
|
other than the tagging you asked about, LGTM |
* All docs are now in one place which simplifies handling * Specific branch to start your beat on was defined to prevent people using master This change will prevent people creating a new beat to rely on master and have a stable branch for development. This also allows us to modify the generator without having all docs out of sync directly. The blog post "Build your own beat" should be updated with an "update note" about checking out branch 5.1: https://www.elastic.co/blog/build-your-own-beat Further changes: * Add golang version to version.asciidoc file * Remove copied version.asciidoc files and link global file
ruflin
force-pushed
the
generator-version-update
branch
from
45f53fd to
668b0d7
Compare
ruflin
added a commit
to ruflin/beats
that referenced
this pull request
Jan 9, 2017
Currently cookiecutter is needed to generate a beat. This adds an additional dependency to generate a beat and does not give us a lot of control over which checks should be executed during execution. As our template is quite simple it can be done with basic string replacements. A simple python script is now done for the task which leads to less inputs needed by the user and allows us to do checks like GOPATH setup etc. The script could potentially be done in Golang but the setup of python is needed anyways for development. Further changes: * Rename .go files to .go.tmpl so they are not checked for correct syntax * Update documentation NOTES: * Changes for the metricbeat generator will follow in a second PR. * Blog post about creating a beat should be updated to point to 5.1. See elastic#3197
monicasarbu
pushed a commit
that referenced
this pull request
Jan 13, 2017
Currently cookiecutter is needed to generate a beat. This adds an additional dependency to generate a beat and does not give us a lot of control over which checks should be executed during execution. As our template is quite simple it can be done with basic string replacements. A simple python script is now done for the task which leads to less inputs needed by the user and allows us to do checks like GOPATH setup etc. The script could potentially be done in Golang but the setup of python is needed anyways for development. Further changes: * Rename .go files to .go.tmpl so they are not checked for correct syntax * Update documentation NOTES: * Changes for the metricbeat generator will follow in a second PR. * Blog post about creating a beat should be updated to point to 5.1. See #3197
ruflin
removed
the
needs_backport
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.
This change will prevent people creating a new beat to rely on master and have a stable branch for development. This also allows us to modify the generator without having all docs out of sync directly.
The blog post "Build your own beat" should be updated with an "update note" about checking out branch 5.1: https://www.elastic.co/blog/build-your-own-beat
This is in preparation for #2996