Commit Graph

27 Commits

Author SHA1 Message Date
Xingjian Zhang 24a9c69551 doc: Fix docs about installation
Change-Id: I0179c718926b3b2100859d7f66dcc6603594abf0
2022-09-26 16:21:38 +08:00
Andrey Pavlov f9e75281b4 fix UT for cinderclient
- bump version from 2 to 3 for cinderclient
- update aws ec2 interface for create_colume and
  create_network_interface. add cilent_token param
- fix describe network interface - something was
  changed in neutron ports output
- set metadata port for OVN conf file also

Change-Id: Ie3e5a5930d5a8159050ecc0900239935558dddd7
2021-09-28 19:24:15 +00:00
Andrey Pavlov 2a5a97344d doc: Update our IRC server to OFTC
Change-Id: I720a97be223cb03d9722b1b92990534d8ee0fdba
2021-06-08 11:50:24 +03:00
Ghanshyam Mann 084d252809 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38521
Change-Id: I7f2fc02c036d71d76e1b6f69879641fef3271207
2021-05-13 18:12:21 -05:00
Takashi Kajinami eb3b4851a9 Use volume v3 API by default
Currently ec2api uses the volume v2 API by default, but v2 API was
deprecated a while ago and will be removed fron cinder shortly.
This patch ensures that ec2api uses the volume v3 API instead by
default.

Closes-Bug: #1908993
Change-Id: I280d3c009893c67d215b0c7106eec7fe2435c335
2021-01-24 23:34:37 +00:00
Hervé Beraud 1d3e05a6e8 Stop to use the __future__ module.
The __future__ module [1] was used in this context to ensure compatibility
between python 2 and python 3.

We previously dropped the support of python 2.7 [2] and now we only support
python 3 so we don't need to continue to use this module and the imports
listed below.

Imports commonly used and their related PEPs:
- `division` is related to PEP 238 [3]
- `print_function` is related to PEP 3105 [4]
- `unicode_literals` is related to PEP 3112 [5]
- `with_statement` is related to PEP 343 [6]
- `absolute_import` is related to PEP 328 [7]

[1] https://docs.python.org/3/library/__future__.html
[2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html
[3] https://www.python.org/dev/peps/pep-0238
[4] https://www.python.org/dev/peps/pep-3105
[5] https://www.python.org/dev/peps/pep-3112
[6] https://www.python.org/dev/peps/pep-0343
[7] https://www.python.org/dev/peps/pep-0328

Change-Id: I3a0de577d7fc75eb83c143fcf595e01eca676446
2020-06-02 20:12:23 +02:00
Andreas Jaeger 69f4b79813 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I10e31a8883739e8844b9d974cf4da62cfc28efe0
2020-05-30 16:44:50 +02:00
Andreas Jaeger 2bf5e4c0b3 Cleanup docs building
* Switch to newer openstackdocstheme version and remove values that are
  set now by openstackdocstheme.
* Remove py2 requirments for docs, we only build with python3.
* Update deps for docs building, we don't need the default.
* Remove modindex, this is not build, see
  https://docs.openstack.org/ec2-api/latest/py-modindex.html

Change-Id: I6958cbed944de0a1eea02de10c5a4916b6a7293d
2020-02-23 14:18:20 +01:00
caoyuan 9ccf7cf414 tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: I96e52fe2f0b14d359f37964c3bd51b1ba985dac0
2019-10-24 21:07:06 +08:00
Stephen Finucane 8ec74422a0 docs: Add separate 'doc/requirements.txt' file
Just to help us separate the documentation-focused requirements from
everything else.

Change-Id: I69e9290addd4424fd8360bffcabc118824a24e20
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2019-10-02 09:47:15 +01:00
Stephen Finucane f35ffb70b5 tox: Misc fixes
- Use 'ignore_basepython_conflict' so we can simply define 'basepython'
  on the base testenv
- Add an '.stestr.conf' file, allowing us to stop specifying the
  '--test-path' argument manually
- Call 'sphinx-build' directly instead of using the 'build_sphinx'
  distutils extension, which pbr is deprecating. This requires a fix to
  the docs but allows us to remove some noise from 'setup.cfg'
- Fix some indentation and remove some unnecessary configuration

Change-Id: Icc16ed943d8c0b9df01734da5642bf51e83314b8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2019-10-02 09:47:12 +01:00
Zuul 1fa62312fe Merge "Revert "temporary disable functional tests"" 2019-10-01 08:37:13 +00:00
Andrey Pavlov 1886d64d3e Revert "temporary disable functional tests"
This reverts commit 3d6106d99c.

Change-Id: I390634d5321d3f4210a5d378178c8d8b1e445e19
2019-10-01 06:06:46 +00:00
caoyuan b1f4ce5593 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I1289490d8adb6910eb03d152fa4c88bd4682e4af
2019-09-13 02:03:40 +00:00
Andreas Jaeger b0361c0438 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Ib3f8664195986bae45123061cd2afc816c6403d8
2019-07-22 18:38:32 +02:00
Vu Cong Tuan 8a3358e2d1 Replace deprecated "auth_uri" by "www_authenticate_uri"
According to [1], "auth_uri" has been deprecated.
This patch replace it by using "www_authenticate_uri" instead.

[1] https://review.openstack.org/#/c/508522

Change-Id: I3242394fd4ebfa7eda390be872372a53b5311a46
2018-05-11 09:54:02 +07:00
melissaml 257e2a34a6 Fix the incorrect reference links
TrivialFix
[1] is the installation guide for OpenStack components, obviously,
we need [1] in the docs.

[1] https://docs.openstack.org/latest/install/

Change-Id: I5a46d7b9f6a1cf67d06e3fd121b8c60d227a23f7
2018-02-26 16:02:15 +08:00
Andrey Pavlov ec59a03f95 update documentation
remove link to metadata configuration from
devstack section. metadata is configured by plugin's
script for devstack and user doesn't require to
configure it by himself.
Add information how to configure metadata over SSL

Change-Id: I9ecfc10fed15a73417e840ddecac8a8a56d18601
Closes-Bug: #1739479
2018-02-08 16:01:29 +03:00
Zuul ee5a7ee09e Merge "rework tox.ini" 2017-10-20 15:19:16 +00:00
tikitavi 0445156611 rework tox.ini
separate works for py27, py35
add docs test
some other changes to let tests pass

Change-Id: I94291a5e65fee1e266fbe4e2ec3e14f042654598
2017-10-20 12:16:30 +03:00
tikitavi 41309f5922 update of Installation Guide
added sections Manual Installation and Installation on DevStack

Change-Id: I206ae2e5fdd13a4cac700189d388578777b589c6
2017-10-16 15:54:29 +03:00
tikitavi aaf1fc94f8 Move install guides from install-guide/ to doc/source/install
Update documentation index page

Change-Id: I94b832638d9c1460fbefd1a61a850496b07124ab
2017-09-28 16:55:45 +03:00
tikitavi 9e91db17aa Add configuration reference to doc/source/configuration
Change-Id: I077f4e7c3b12689f809cd68177e00a097d6cd0a2
2017-09-28 16:55:10 +03:00
Vu Cong Tuan 5f1377bb94 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I39e3cc70f51f9ebb2973ea5a7e6cb12d3b19d6cb
Closes-Bug:#1693670
2017-06-04 12:27:00 +07:00
Thomas Bechtold 5024a8cb78 Fix doc build if git is absent
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: I2c219d64e33ab8af7e883e6153855d040d8f8f38
Closes-Bug: #1552251
2016-04-13 09:51:11 +02:00
Harshada Mangesh Kakad 095cb42e44 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: Iff4999077b46b84054a6c7c5d1c8b7b28428f24d
Closes-Bug: #1529836
2016-01-14 06:33:00 -08:00
Andrey Pavlov 87ea3a4bac add template for documentation
Change-Id: I3674443191a2cf4f49d18a3dc521765c3e778737
2015-04-15 18:09:33 +03:00