diff --git a/README.rst b/README.rst index 3e5fe671a3..81b621b42c 100644 --- a/README.rst +++ b/README.rst @@ -5,46 +5,14 @@ Savanna at wiki.openstack.org: https://wiki.openstack.org/wiki/Savanna Launchpad project: https://launchpad.net/savanna -Project blueprint: https://savanna.readthedocs.org/en/latest/index.html +Savanna docs site: https://savanna.readthedocs.org/en/latest/index.html -Architecture draft: https://savanna.readthedocs.org/en/latest/architecture.html +Roadmap: https://wiki.openstack.org/wiki/Savanna/Roadmap -Roadmap: https://savanna.readthedocs.org/en/latest/roadmap.html +Quickstart guide: https://savanna.readthedocs.org/en/latest/devref/quickstart.html -API draft: https://savanna.readthedocs.org/en/latest/restapi/v02.html +How to participate: https://savanna.readthedocs.org/en/latest/devref/how_to_participate.html -QuickStart (Ubuntu) ----------- - -Please, take a look at https://savanna.readthedocs.org/en/latest/quickstart.html - - -Pip speedup ------------ - -Add the following lines to ~/.pip/pip.conf -:: - [global] - download-cache = /home//.pip/cache - index-url = - -Note! The ~/.pip/cache folder should be created. - -Git hook for fast checks ------------------------- -Just add the following lines to .git/hooks/pre-commit and do chmod +x for it. -:: - #!/bin/sh - # Run fast checks (PEP8 style check and PyFlakes fast static analysis) - tools/run_fast_checks - -You can added the same check for pre-push, for example, run_tests and run_pylint. - -Running static analysis (PyLint) --------------------------------- -Just run the following command -:: - tools/run_pylint License ------- diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst index 4925c97bbe..7b09a6cc17 100644 --- a/doc/source/devref/development.environment.rst +++ b/doc/source/devref/development.environment.rst @@ -83,3 +83,33 @@ Setup local OpenStack dashboard with Savanna plugin ../horizon/dev.environment.guide + +Tips and tricks for dev environment +----------------------------------- + +1. Pip speedup + +Add the following lines to ~/.pip/pip.conf +:: + [global] + download-cache = /home//.pip/cache + index-url = + +Note! The ~/.pip/cache folder should be created. + +2. Git hook for fast checks + +Just add the following lines to .git/hooks/pre-commit and do chmod +x for it. +:: + #!/bin/sh + # Run fast checks (PEP8 style check and PyFlakes fast static analysis) + tools/run_fast_checks + +You can added the same check for pre-push, for example, run_tests and run_pylint. + +3. Running static analysis (PyLint) + +Just run the following command +:: + tools/run_pylint +