Add build docs script #1873
Merged
Add build docs script #1873
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
added
review
needs_backport
|
@dedemorton This means in the future you can just run |
ruflin
force-pushed
the
automate-docs
branch
2 times, most recently
from
dd3a95f to
78e2ac1
Compare
|
@andrewkroh I removed the doc build in Jenkins to replace it by this PR. Should we backport this to 1.3, at least the overall docs build? |
| .PHONY: testsuite | ||
| testsuite: | ||
| $(foreach var,$(PROJECTS),$(MAKE) -C $(var) testsuite || exit 1;) | ||
| #$(MAKE) -C generate test | ||
| $(MAKE) docs |
There was a problem hiding this comment.
I would prefer to not have the docs build tied to testsuite. I would rather be able to specify if I want them both to run like make testsuite docs.
There was a problem hiding this comment.
I kept it in to not have to change the jenkins command and it is currently incompatible with 1.3. but I will just update 1.3 very soon, so this is not a problem. I removed it.
|
Yeah, it would be good to backport at least the |
To build the docs, `make docs` can be used. To preview the docs, `make docs-preview` can be used. * Building the docs is now part of make testsuite * Make local docs build and preview easy by adding it to the makefile * Update CONTRIBUTING.md with new commands The generators are currently not part of the build as they require glide to be installed.
ruflin
added a commit
to ruflin/beats
that referenced
this pull request
Jun 16, 2016
Backport elastic#1873
Merged
ruflin
removed
the
needs_backport
leweafan
pushed a commit
to leweafan/beats
that referenced
this pull request
Apr 28, 2023
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.
Building the docs is now part of make testsuite
Building of the generators was also added to the testsuite.