Skip to content

Commit 81f0101

Browse files
author
Nathan Speidel
committed
Fixed mkdocs version and a small fix
1 parent 602992b commit 81f0101

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@ The built documentation can be accessed [here](https://yahoo.github.io/bullet-do
66

77
## Building the documentation
88

9-
You need [mkdocs](http://www.mkdocs.org/#installation) installed to build the documentation.
10-
11-
This also uses the mkdocs theme : [Cinder](http://sourcefoundry.org/cinder/).
12-
13-
Since Cinder has not been upgraded in a while, you will need to bring in changes in this [PR](https://github.com/chrissimpkins/cinder/pull/26) of Cinder found here: [twardoch/clinker-mktheme](https://github.com/twardoch/clinker-mktheme/tree/2016-12-22)
14-
and add on this fix in this [PR](https://github.com/twardoch/clinker-mktheme/pull/10)
15-
16-
You will also need Python installed.
9+
You will need Python installed.
1710

1811
```bash
1912
sudo pip install virtualenv
2013
virtualenv mkdocs
2114
source mkdocs/bin/activate
15+
pip install mkdocs==0.16.3
2216
pip install mkdocs-cinder
23-
pip install git+git://github.com/twardoch/clinker-mktheme.git@2016-12-22 --upgrade
17+
pip install git+git://github.com/twardoch/clinker-mktheme.git@master --upgrade
2418
git clone git@github.com:yahoo/bullet-docs.git
2519
cd bullet-docs
26-
mkdocs build
20+
mkdocs serve
2721
```
2822

23+
The above commands will install [mkdocs](http://www.mkdocs.org/#installation) along with the mkdocs theme : [Cinder](http://sourcefoundry.org/cinder/).
24+
25+
Since Cinder has not been upgraded in a while, it uses the changes in this [PR](https://github.com/chrissimpkins/cinder/pull/26) of Cinder found here: [twardoch/clinker-mktheme](https://github.com/twardoch/clinker-mktheme/tree/master).
26+
2927
## Building the examples
3028

3129
You will need [Maven 3](https://maven.apache.org/install.html) and [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed to build the examples.

docs/quick-start.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ storm logviewer &
7575
storm supervisor &
7676
```
7777

78+
It may take 30-60 seconds for all the components to launch.
79+
7880
Once everything is up without errors, visit [http://localhost:8080](http://localhost:8080) and see if the Storm UI loads.
7981

8082
#### Step 4: Test Storm (Optional)

0 commit comments

Comments
 (0)