README and docs has been updated
* links has been updated * tips moved to the dev guide Change-Id: I89444a8fa987850ca22b7975707b201f9c76de71
This commit is contained in:
parent
992f36936d
commit
64c9cb0249
40
README.rst
40
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/<username>/.pip/cache
|
||||
index-url = <mirror 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
|
||||
-------
|
||||
|
@ -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/<username>/.pip/cache
|
||||
index-url = <mirror 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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user