Unify doc version handling #1919
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
|
CC @dedemorton |
|
@tsg Great idea! But shouldn't we also have a variable for the branch so that we can set the paths too? So you would have a variable called something like doc-branch that sets the branch for each doc. For example: Then in version.asciidoc, we would have: I'm just concerned that we might update the version without remembering to update the path. We use variables like {libbeat} in links between different books. |
added 2 commits
June 28, 2016 09:39
The new file `libbeat/docs/version.asciidoc` contains a single line with the `stack-version` variable. All other version variables reference this one. This makes it easy to automate version changing. `make update` is needed to copy the file to the individual Beats. It would have been possible to include directly the file from libbeat, but that would have had a big disadvantage: the docs only get rebuild on file changes in the "book", so changing the version in libbeat wouldn't trigger a docs rebuild on the public website. Also, it's kind of nice to have to run `make update` shortly before each release, that makes it sure we won't forget.
tsg
force-pushed
the
single_version_in_docs
branch
from
5d021fc to
4b80571
Compare
|
@dedemorton ah, yes, we need that as well. I added it in a second commit. Can you have a look again, please? |
|
+1 on this idea. |
|
LGTM. I did not pull the files and test the build, tho. I'll assume you did that. :-) |
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 new file
libbeat/docs/version.asciidoccontains a single line with thestack-versionvariable. All other version variables reference this one. Thismakes it easy to automate version changing.
make updateis needed to copy the file to the individual Beats. It would havebeen possible to include directly the file from libbeat, but that would have had
a big disadvantage: the docs only get rebuild on file changes in the "book", so
changing the version in libbeat wouldn't trigger a docs rebuild on the public
website.
Also, it's kind of nice to have to run
make updateshortly before each release,that makes it sure we won't forget.