azkaban-aplcache
Changes
docs/README.rst 8(+1 -7)
README.md 22(+19 -3)
requirements.txt 1(+1 -0)
tools/README.md 7(+0 -7)
Details
docs/README.rst 8(+1 -7)
diff --git a/docs/README.rst b/docs/README.rst
index fcae7cf..2bb2c1d 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -1,13 +1,7 @@
Make sure python3 is installed in your environment. python virtual environment is recommended to run these scripts.
-To download the dependencies, run
-
-```bash
-pip3 install -r requirements.txt
-```
-
After sphinx is successfully installed, run::
make html
-Check out the generated ``_build`` folder, where the static html documentation site is built.
\ No newline at end of file
+Check out the generated ``_build`` folder, where the static html documentation site is built.
README.md 22(+19 -3)
diff --git a/README.md b/README.md
index 757a927..23a68b0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# Azkaban
-[](https://travis-ci.org/azkaban/azkaban)[](https://codecov.io/github/azkaban/azkaban)[](https://gitter.im/azkaban-workflow-engine/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[](https://travis-ci.org/azkaban/azkaban)[](https://codecov.io/github/azkaban/azkaban)[](https://gitter.im/azkaban-workflow-engine/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[](http://azkaban.readthedocs.org/en/latest/?badge=latest)
+
## Build
Azkaban builds use Gradle and requires Java 8 or higher.
@@ -42,11 +43,26 @@ Build
```
## Documentation
-Documentation is available at [azkaban.github.io](http://azkaban.github.io).
-The source code for the documentation is in the [gh-pages](https://github.com/azkaban/azkaban/tree/gh-pages) branch.
+
+The current documentation will be deprecated soon at [azkaban.github.io](http://azkaban.github.io).
+The [new Documentation site](https://azkaban.readthedocs.io/en/latest/) is under development.
+The source code for the documentation is inside `docs` directory.
For help, please visit the [Azkaban Google Group](https://groups.google.com/forum/?fromgroups#!forum/azkaban-dev).
## Developer Guide
See [the contribution guide](https://github.com/azkaban/azkaban/blob/master/CONTRIBUTING.md).
+
+If you want to contribute to the documentation or the release tool (inside the `tools` folder),
+please make sure python3 is installed in your environment. python virtual environment is recommended to run these scripts.
+
+To download the python3 dependencies, run
+
+```bash
+pip3 install -r requirements.txt
+```
+
+
+**[July, 2018]** We are actively improving our documentation. Everyone in the AZ community is
+welcome to submit a pull request to edit/fix the documentation.
tools/README.md 7(+0 -7)
diff --git a/tools/README.md b/tools/README.md
index c8af3f4..1a5be41 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -1,9 +1,2 @@
The python scripts in this direcory require python3.
-
A python virtual environment is recommended to run these scripts.
-
-To download the dependencies, run
-
-```bash
-pip3 install -r requirements.txt
-```