This is an automated email from the ASF dual-hosted git repository.
srdo pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/storm-site.git
commit 0ad130cd84fc618d7f88635191f2a539eaa90492
Author: Stig Rohde Døssing <stigdoess...@gmail.com>
AuthorDate: Sat Sep 21 09:05:19 2019 +0200
Update README so command to build Storm javadoc actually works, bump ruby
gems
---
Gemfile.lock | 2 +-
README.md | 4 +++-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/Gemfile.lock b/Gemfile.lock
index 2250684..b949c38 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -237,4 +237,4 @@ DEPENDENCIES
redcarpet (~> 3.2, >= 3.2.3)
BUNDLED WITH
- 1.16.1
+ 2.1.0.pre.1
diff --git a/README.md b/README.md
index eaf17dc..839e6fc 100644
--- a/README.md
+++ b/README.md
@@ -29,9 +29,11 @@ In order to add a new release, you must have committer
access to the storm-site
You must first generate Javadoc for the new release. Check out the Storm
repository from https://github.com/apache/storm, and check out the version of
the code you are releasing.
+You must have already installed the storm-shaded-deps module, so please run
`mvn clean install -pl storm-shaded-deps -am` if you haven't built Storm
already.
+
In the Storm project root run
```
-mvn javadoc:aggregate -DreportOutputDirectory=./docs/ -DdestDir=javadocs
-Dnotimestamp=true -P '!include-shaded-deps'
+mvn javadoc:aggregate -DreportOutputDirectory=./docs/ -DdestDir=javadocs
-Dnotimestamp=true -pl '!storm-shaded-deps'
```
In the storm-site project, release documentation is placed under the releases
directory named after the release version. See
[below](#how-release-specific-docs-work) for details about release specific
documentation.
