Definition
This vagrant project collects information about to setup tools for developing on ONAP project. That includes cloning source code, installing dependencies and building and deploying artifacts.
Problem Being Solved
- Reduce the barrier of entry to allow new ONAP developers to ramp up on to active development quickly
- Reduce the cost to the community in responding to simple environment setup questions faced by new developers
Change log
| Date | Description |
|---|---|
| 2017-08-09 | Added support to generate HTML documentation through `tox -e docs` command |
| 2017-08-08 | Created Run.ps1 as a helper script for Windows users |
| 2017-08-06 | Created unit tests for A&AI component |
| 2017-08-02 | Migrated into Integration project under /integration/bootstrap/vagrant-onap |
Generate HTML documentation
The documentation of this project was written in reStructuredText format which is located under the docs folder. It's possible to format these documents into HTML using Sphinix python tool.
$ git clone https://git.onap.org/integration
$ cd integration/bootstrap/vagrant-onap
$ sudo pip install -y tox
$ tox -e docs
This results in the creation of a new ./doc/build/html folder with the documentation converted in HTML pages that can be viewed through the preferred Web Browser.