diff --git a/README.md b/README.md index f5284086..3be85ef5 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ You can install the required tool "mkdocs" like this (a "mkdocs" directory will sudo pip install virtualenv virtualenv mkdocs source mkdocs/bin/activate -pip install mkdocs==0.16.3 +pip install mkdocs==0.16.3 pip install mkdocs-cinder pip install git+git://github.com/twardoch/clinker-mktheme.git@master --upgrade ``` @@ -31,16 +31,16 @@ Running `make release` will save the docs currently in the master branch, and th **To add new JavaDocs:** * In src branch: - * Create new folder for the docs. e.g. `mkdir -p docs/java-docs/bullet-core/0.4.3/` - * Create a place-holder file. e.g. `cp docs/java-docs/bullet-core/0.4.2/index.html docs/java-docs/bullet-core/0.4.3/` - * Add the appropriate link in docs/releases.md (or wherever you want the link). e.g. `[JavaDocs](java-docs/bullet-core/0.4.3/index.html)` + * Create new folder for the docs. e.g. `mkdir -p docs/apidocs/bullet-core/0.4.3/` + * Create a place-holder file. e.g. `cp docs/apidocs/bullet-core/0.4.2/index.html docs/apidocs/bullet-core/0.4.3/` + * Add the appropriate link in docs/releases.md (or wherever you want the link). e.g. `[JavaDocs](apidocs/bullet-core/0.4.3/index.html)` * Commit these changes to the src branch. e.g. `git add -A && git commit -m "Added new JavaDocs"` * Push src branch to remote * Build a release: `make release` - this will leave you in the master branch with a new build ready NOT including the new docs you want to add * In master branch after doing "make release" BEFORE pushing to remote: - * Create new folder for the docs. e.g.: `mkdir -p java-docs/bullet-core/0.4.3` - * Copy the contents of the new JavaDocs into the new folder. e.g. `cp -r ~/PATH-TO-NEW-DOCS/bullet-core/target/site/apidocs/* java-docs/bullet-core/0.4.3/` - * Commit these changes to the master branch. e.g. `git add -A && git commit -m "Build at abc123 with new JavaDocs"` + * Create new folder for the docs. e.g.: `mkdir -p apidocs/bullet-core/0.4.3` + * Copy the contents of the new JavaDocs into the new folder. e.g. `cp -r ~/PATH-TO-NEW-DOCS/bullet-core/target/site/apidocs/* apidocs/bullet-core/0.4.3/` + * Commit these changes and amend the last commit (the regular build without your docs) to the master branch. e.g. `git add -A && git commit --amend` * Push master branch to remote ## Building the Documentation diff --git a/docs/backend/dsl.md b/docs/backend/dsl.md new file mode 100644 index 00000000..a17a151e --- /dev/null +++ b/docs/backend/dsl.md @@ -0,0 +1 @@ +### Coming soon! diff --git a/docs/pubsub/pulsar.md b/docs/pubsub/pulsar.md new file mode 100644 index 00000000..a17a151e --- /dev/null +++ b/docs/pubsub/pulsar.md @@ -0,0 +1 @@ +### Coming soon! diff --git a/mkdocs.yml b/mkdocs.yml index 6339103c..a923db87 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,7 +12,9 @@ pages: - Spark: quick-start/spark.md - Storm: quick-start/storm.md - Backend: - - Getting your data into Bullet: backend/ingestion.md + - Data Ingestion: + - Record Container: backend/ingestion.md + - DSL: backend/dsl.md - Storm: - Architecture: backend/storm-architecture.md - Setup: backend/storm-setup.md @@ -25,6 +27,7 @@ pages: - Architecture: pubsub/architecture.md - Kafka: pubsub/kafka.md - REST: pubsub/rest.md + - Pulsar: pubsub/pulsar.md - Storm DRPC: pubsub/storm-drpc.md - Web Service: - Setup: ws/setup.md