Commit Graph

10 Commits

Author SHA1 Message Date
Ivan Kolodyazhny efce9c74d0 Update Development Environment documentation for Ubuntu
Ubuntu 20.04 is supported now so we need to install Python3-specific
packages only for development environnment.

Change-Id: I1a82ae20228513e5bbd01f596c817cc62e838de1
2020-11-03 14:01:41 +02:00
Sean McGinnis c0d06dd1f9
Remove py2 mentions from contributor docs
We had information about running py27 tox targets that can now be
removed. We also had special notes about getting py3 set up, but since
that is now part of the default setup of a development environment, that
can be removed.

Change-Id: I6d49fe02d3a5b826cf93076a0828450ca52220cc
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-11-12 16:34:35 -06:00
Luigi Toscano 11d74a2f08 Small doc updates: canonical URLs, rally doc, etc
- use the canonical URL on opendev.org for OpenStack projects
  whenever it is possible;
- use a reference to cinder-specs instead of the code repository;
- update few rally URLs, removing one which does not exist anymore;
- update the repository URL of the datera driver.

Change-Id: Ib14346026bd34f90aea588c35407e5e2af505866
2019-06-04 17:57:16 +02:00
Zuul fc2897c165 Merge "Update macOS devref info" 2018-06-15 17:19:24 +00:00
Sean McGinnis e80deb0510 Update macOS devref info
Mac OS X was renamed to macOS starting with Sierra in 2016. This
updates the development environment information to update the name
and note that unit tests and development are not fully supported
when using this OS.

Includes various doc formatting cleanup as well since I was making
changes to the file.

Change-Id: Ia62ac91add51450dc99c431e9f64732553495558
2018-06-14 13:27:33 -05:00
Sean McGinnis ac9a9343e6 Add ansible helper to Linux dev environment info
This adds instructions on how to use an Ansible playbook to
quickly get a working dev environment set up for Linux
environments as an alternative options to manually installing
packages

Change-Id: Ib9d932fca7002299537a1c0da4053a671ce3ccb1
2018-06-14 08:24:50 -05:00
Van Hung Pham d87d69fbb6 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I9cedef5883b831c109217ca04d2575ce7970b7aa
2018-05-29 18:53:46 +07:00
zejian Zhuang 38e5e7376b Update setup instructions
Add python3-dev instructions for Ubuntu16.04.
Verified thos packages in new version and drop Ubuntu12.04 tag.

Change-Id: I59849d0b5b1ec6636ad1e1af004277fcfa319473
Close-Bug: #1659568
2017-11-01 10:07:07 +08:00
shangxiaobj 83dd1ddd68 Update and replace http with https for doc links in Cinder
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links

Change-Id: I9b8473a439d15c741bc4d4809c4c4c122717f8a4
2017-07-27 09:58:23 +00:00
Jay S. Bryant 1423480fb6 Make doc/source directory compliant with design in spec
The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
2017-07-19 15:59:02 -05:00