Commit Graph

997 Commits

Author SHA1 Message Date
guolimin.lc f061c30f2b Modify the URL field in the document, uniform case
Change-Id: Ie22a98532953c88de7f4937397b5982281c657fc
2023-09-06 12:42:40 +08:00
guolimin.lc c53639d3b0 Updated links in documentation to be currect links
Change-Id: I256e24dfe6928ffc73dbae42fd494f896747c3f0
2023-08-09 12:20:10 +08:00
guolimin.lc 5bcf186440 Update the correct link in the docs
Change-Id: I8ac88c9095bb426fb454b1ba475de420a26a5e92
2023-07-26 12:26:32 +08:00
qiufossen 4ac54de863 cannot show the running tox -e pylint command
https://docs.openstack.org/sahara/latest/contributor/development-environment.html

Change-Id: I04fbaa0d69c92da0c8b764d64b848121f82f86f8
2022-09-08 18:10:13 +08:00
Zuul f6a4a6e0b7 Merge "Remove the suffix of *console*" 2022-01-27 01:54:51 +00:00
Zuul aff7caef2e Merge "Make unclear code clear in user guide" 2022-01-13 10:18:23 +00:00
Zuul 0da78ddaab Merge "Solve the problem that the code in the xml file is not clear" 2022-01-13 10:13:57 +00:00
Zuul 4ff19a840c Merge "Make hidden code appear in admin guide" 2022-01-13 10:13:55 +00:00
hejunli 4a7f7b462a Solve the problem that the code in the xml file is not clear
https://docs.openstack.org/sahara/latest/user/hadoop-swift.html
cannot show the code clear in xml file, this patch fix that issue.

Change-Id: I7467e3a3665f882587adbaa8e6c50042bc00739c
2022-01-13 15:21:16 +08:00
hejunli e9e50bede6 Let the code in the json file be displayed
https://docs.openstack.org/sahara/latest/user/edp.html
cannot show the code clear, this patch fix that issue.

Change-Id: Ie4f8add7e464c454c41d6c4084ec64d6b7cca3ee
2022-01-13 15:20:04 +08:00
hejunli 257c58ef81 Make hidden code appear in admin guide
https://docs.openstack.org/sahara/latest/admin/advanced-configuration-guide.html
cannot show the CLI commend, this patch fix that issue.

Change-Id: I26b44442279e9a9b067ff3fd6e78d3d079dad919
2022-01-13 15:18:36 +08:00
hejunli 554d23779e Remove the suffix of *console*
https://docs.openstack.org/sahara/latest/user/building-guest-images/sahara-image-create.html
cannot show the CLI commend, this patch fix that issue.

Change-Id: I4fc4a7c66b15d9b87ecbdeefa80985799572c541
2022-01-13 15:15:07 +08:00
hejunli f0a0946c49 Make unclear code clear in user guide
https://docs.openstack.org/sahara/latest/user/quickstart.html
cannot show the CLI commend, this patch fix that issue.

Change-Id: I3bb41f86713facba2fa3811b1e4420e68d0f355a
2022-01-13 15:06:24 +08:00
Zuul c4f4d29847 Merge "Remove the suffix of *console*" 2021-12-29 06:06:12 +00:00
zhangbailin c500c71d06 Remove the suffix of *console*
https://docs.openstack.org/sahara/wallaby/install/installation-guide.html#common-installation-steps
cannot show the CLI commend, this patch fix that issue.

Change-Id: I4d7767bf3aba340a30e99686195236e0e443eb7c
2021-12-28 16:02:58 +08:00
zhangbailin 44acc62a5d Remove the console suffix
https://docs.openstack.org/sahara/wallaby/install/dashboard-guide.html#different-endpoint
cannot show the soucecodes, this patch fixing that error.

Change-Id: I4f00d84fc85254a7e3cbd6c7666cbacae6e37171
2021-12-28 15:24:39 +08:00
Zuul 083be1c06a Merge "using code-block match console section to show the content" 2021-12-27 09:42:48 +00:00
Zuul c344d6632f Merge "code-block replaces the soucecode in install docs section" 2021-12-27 09:40:39 +00:00
Zuul a86f86a119 Merge "code-block replaces sourcecode to clearly display the content" 2021-12-27 09:29:13 +00:00
zhangbailin b8f144abd6 using code-block match console section to show the content
https://docs.openstack.org/sahara/wallaby/user/quickstart.html
cannot show the content, using code-block::console to instead
soucecode::console, make it clearly to show.

Change-Id: Ibbc50904719c5e435e55b52087d5b18bfc1511bb
2021-12-27 15:48:18 +08:00
zhangbailin 24690ea187 code-block replaces sourcecode to clearly display the content
https://docs.openstack.org/sahara/wallaby/install/dashboard-guide.html#different-endpoint
cannot show the soucecodes, this patch fixing that error.

Change-Id: I0d032a116291a7c759bbf07614ce0087fc9cd203
2021-12-27 07:43:14 +00:00
zhangbailin dd1e797ac5 code-block replaces the soucecode in install docs section
https://docs.openstack.org/sahara/wallaby/install/installation-guide.html#common-installation-steps
cannot show the doc's content with soucecodes, instead of using
code-block.

Change-Id: Ie6e2a6c9c9a27cbd976fb3d973f36f02f5b20a96
2021-12-27 15:41:32 +08:00
zhangbailin 5cbfe43e7e change the code-block header of the docs
https://docs.openstack.org/sahara/wallaby/user/plugins.html#managing-plugins
cannot show the code block, try to change with *code-block*.

Change-Id: I3bff505d48a817cb96ddd0055102e35faaf4b97d
2021-12-27 05:37:05 +00:00
songwenping 6728a85ec6 Remove unicode from code in doc conf
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Change-Id: Ie70f5dc84a07c40f3743c56ad6d3673e6e78e1a6
2021-10-25 03:06:21 +00:00
wu.chunyang 622af6949b docs: Update Freenode to OFTC
see: http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022718.html
Change-Id: If2846d95c65e5870adde75f1a23aecc6966eb8f6
2021-06-08 22:01:11 +08:00
Ghanshyam Mann 9a69cc52b6 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc and tests.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: Ib2101f13171940857fe81f64dd9798dfe489743a
2021-03-30 04:02:11 +00:00
Luigi Toscano 8a026b95bd Focal-related fixes: libguestfs, mysql 8, requirements
- use the the python3 guestfs bindings, not the old python2
  (not availbale anymore on the newer systems);
- fix the compatibility with mysql 8, which unfortunately
  removes the shortend for user creation + password setting;
- bump the values in lower-requirements.txt (also requirements.txt
  and test-requirements.txt when needed) so they they work with
  python 3.8 (inspired by other similar bumps).

Change-Id: Icaa3c008bbe179098244f7bb9d80790068430fe2
2020-09-22 18:10:10 +02:00
Zuul cfc7d0365a Merge "Fix duplicated words issue like "is is provided to"" 2020-05-20 20:56:21 +00:00
zhufl 1e8d93841f Fix duplicated words issue like "is is provided to"
This is to fix the duplicated words issue like
"This object is is provided to the plugin"

Change-Id: I857463b9fd9a1db9763fd0a335c8b9413f35ed62
2020-05-20 08:29:06 +00:00
Zuul d40deb1505 Merge "Ussuri contributor docs community goal" 2020-04-23 11:34:30 +00:00
Jeremy Freudberg 3a3dbc85a3 Ussuri contributor docs community goal
- Updated CONTRIBUTING.rst per goal guidelines
- Created doc/source/contributor/contributing.rst per goal guidelines
- Remove some now-redundant docs

Change-Id: I997c8eab905e37f46e4cb546ea69e284673eea6b
2020-04-22 12:44:53 -04:00
Andreas Jaeger 7977b49dda Cleanup Python 2.7 support
OpenStack is dropping the py2.7 support in ussuri cycle.

Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove ancient pbr section from setup.cfg
- Update requirements
- Use newer openstackdocstheme and setup storyboard support for it
- Remove Babel as requirement, this is not needed here anymore.

Change-Id: I0fd6fbdcbe788b0dfc2b1e20989b0a19ceec59f5
2020-04-22 08:31:22 +02:00
Dirk Mueller 0825bddef6 Fix syntax error in image widths
I get when building sahara this error:

  File "/usr/lib/python3.6/site-packages/sphinx/writers/html5.py", line 548, in visit_image
     atts['width'] = int(atts['width']) * scale
  ValueError: invalid literal for int() with base 10: '800px'

As it turns out, the default is pixels anyway, so we don't need to add a
type suffix. For scale to work, we need to specify both width and height
for images, otherwise sphinx reports an error.

Change-Id: If0f8383e37a8b1185a8a08b24c79b313fdcb498c
2020-03-17 11:07:26 +01:00
yangyong 9cf30f6003 fix invaild link of installation guide in Sahara UI User Guide
update unsuitable links with the proper ones

Change-Id: Ib7516bea5b6ce8bfaf816c9b0cfdf547babddea7
2019-10-24 10:10:34 +00:00
Alexandra Settle 6e3e4b91c2 Fixing broken links and removing outdated driver
zmq is deprecated, removing unnecessary content

Change-Id: I1009205ee8298065cece5f0cda228b06a1281f14
Backport: stein rocky
Signed-off-by: Alexandra Settle <asettle@suse.com>
Co-Authored-By: Jeremy Freudberg <jeremyfreudberg@gmail.com>
2019-09-20 11:37:18 -04:00
Andreas Jaeger ea37e56a85 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: Ia2242298903dd9eab02042860b554b5fc0d73312
2019-07-22 18:31:05 +02:00
pengyuesheng 9f0f1b9472 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

This will show other versions of the doc, too.

Change-Id: Id73bbf0a844dee39f9c72df72b1bdb49fa094806
2019-07-01 15:25:28 +08:00
Zuul 89b0e21e21 Merge "Remove some files not worth maintaining" 2019-06-25 17:25:16 +00:00
Zuul 98082e7842 Merge "Update keystone_authtoken config reference" 2019-06-20 14:14:45 +00:00
Jeremy Freudberg 865858460c Remove some files not worth maintaining
Change-Id: I4d7fc4b212a42c29839e1c6915ec6aab3ee4ed15
2019-06-20 09:59:19 -04:00
Zuul e6c7c42f35 Merge "doc: additional git.openstack.org->opendev.org replacement" 2019-06-20 07:48:22 +00:00
Colleen Murphy 113382e9a6 Update keystone_authtoken config reference
The auth_uri parameter of keystonemiddleware was renamed to
'www_authenticate_uri'[1], so update the documentation accordingly.
Additionally, the identity_uri parameter was deprecated in favor of
using a keystoneauth plugin[2], so this change updates the documentation
to point to the plugin parameters. Finally, the keystone v2 API was
dropped[3], so reference the v3 API.

[1] https://review.opendev.org/508522
[2] https://review.opendev.org/127066
[3] https://review.opendev.org/572846

Change-Id: I146e6d92008409ce219b18caaaa643c7f4496054
2019-06-18 11:10:28 -07:00
Luigi Toscano c5aafbc3ed Fix requirements (bandit, sphinx, jsonschema) and jobs
Requirements:
- bandit 1.6.0 contains a regression in the handling of patterns.
  A fix is in place in bandit master, but newer versions introduces
  more checks so they are not working as well.
  The version is excluded there because is not handled by global
  requirements.

  Remove the separate requirement file for bandit, because
  bandit has been part of test-requirements.txt in the last 3 years.
  There is noneed for a separate requirements file anymore.
  Even more, the bandit tox environment could be probably removed.

- synchronize the requirements for sphinx and jsonschema with the
  current values from the requirements repository to make
  the requirements-check job happy.

Jobs:
- temporarily disable the scenario-py3 job until a new stestr
  (>2.3.1) is tagged.

Change-Id: Ief8e392fcd2d66a73593abcfda06fc7dbe2e53a6
2019-06-17 15:43:10 +02:00
Luigi Toscano e644d4a6a8 doc: additional git.openstack.org->opendev.org replacement
- more replacements (review.openstack.org->review.opendev.org)
- fix an error introduced in the previous commit (by me)

Change-Id: I41ed93390a501e82ff70f4abec0b217e6b5d4707
2019-04-22 21:42:59 +02:00
Luigi Toscano 8c941ed187 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Depends-On: https://review.opendev.org/653988
Change-Id: I6c7fffc1a32cb35ff7fe2ba964510b4f32805842
2019-04-20 14:55:03 +02:00
Ian Wienand 617be9032c Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: Ic57069fd0acc405347e263a082ea8ba9915e9d41
2019-03-24 20:36:02 +00:00
Luigi Toscano bb5f75db7f doc: refer to the split plugin documentation
Remove the detailed information about the plugins from the
core documentation and redirect to the plugins documentation instead.

A redirect has been set to not break the existing links.

Change-Id: Ief8593b02242748a5ffd4f55515975faebd19523
2019-03-20 12:36:25 +01:00
Telles Nobrega 0b8002a99d APIv2 - api-ref documentation for APIv2
Writing api-ref for APIv2.

Story: #2002102
Task: #19780

Change-Id: Ib9e855c11f03239e70306d12e96194549d2dc0f3
2019-01-07 14:59:23 -03:00
Nicolas Haller 5bb7f3797c doc: Fix the snippet in "The Script Validator" section
In the snippet of code, store_nfs_version should point to an object
instead of an array.

Change-Id: I5093baf6fa849acba0dcacdc813ec22f01c35a84
2018-12-05 11:18:31 -05:00
Zuul be47e5c134 Merge "Update devel info: mailing list, meeting time" 2018-12-04 12:27:13 +00:00