azkaban-aplcache
Details
docs/README.md 1(+1 -0)
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..c90c539
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1 @@
+If you want to contribute to the documentation, please follow the [README](https://github.com/azkaban/azkaban) in the root level of the project.
\ No newline at end of file
README.md 7(+7 -0)
diff --git a/README.md b/README.md
index 23a68b0..26e1550 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,8 @@ For help, please visit the [Azkaban Google Group](https://groups.google.com/foru
See [the contribution guide](https://github.com/azkaban/azkaban/blob/master/CONTRIBUTING.md).
+#### Documentation development
+
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.
@@ -62,6 +64,11 @@ To download the python3 dependencies, run
```bash
pip3 install -r requirements.txt
```
+After, enter the documentation folder `docs` and make the build by running
+```bash
+cd docs
+make html
+```
**[July, 2018]** We are actively improving our documentation. Everyone in the AZ community is