Commit Graph

175 Commits

Author SHA1 Message Date
niuke 4a035775a0 remove unicode prefix from code
Change-Id: Ib26f5d6b8415fdf454783b7120434ffd43ed5559
2022-08-15 10:05:54 +08:00
wanghao fad3fa1416 [community 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

Change-Id: I4407ab803cf3dfd66ab3c5b25f8f0db85147cdc5
2021-06-15 16:28:28 +08:00
wanghao cbaadc0e23 [doc]Update IRC Info
Move Zaqar IRC channel from freenode to OFTC

Change-Id: I1eb619420b7a0c7616160ee288e44dfcb133fe69
2021-06-15 09:47:40 +08:00
Ghanshyam Mann 948e88c268 [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: I595b8c7cad7bb02486c8f0dd29fdc40789fc8e50
2021-02-17 00:58:28 +00:00
melissaml e195c8112b Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_auto_name to use 'project' as name.

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: Ie623e7a2389c292ffc71a285f0fc2d4bb9820c3f
2020-05-26 14:03:34 +08:00
Andreas Jaeger b6e1688b24 Doc cleanups
Switch to newer openstackdocstheme and remove settings that
are default now.

Change-Id: I27895a6fb91ba3be37831a697098718082eec00f
2020-05-13 17:49:28 +08:00
Ghanshyam Mann 22ade4fa77 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Zaqar is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Depends-On: https://review.opendev.org/#/c/693631/

Change-Id: I0fde9d2f16f3cc77be3d4cab482fa0fb7ab9e7fc
2019-12-13 00:22:57 +00:00
Zuul c32ba8f4f9 Merge "Rename review.openstack.org to review.opendev.org" 2019-08-27 04:16:19 +00:00
Andreas Jaeger d535a96ee8 Fix api-ref link
The name of the API is message, not messaging - fix the link.

Change-Id: I9371cd91f1a14becd28fd226ce54d066012d1c20
2019-08-08 10:14:05 +02:00
Andreas Jaeger 5f9b4327d9 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: Ia47f486c79a108f6d4ffa419c59b91ad1199c718
2019-07-22 18:49:39 +02:00
Sean McGinnis a0aba998f7
Switch to using stestr directly
ostestr is deprecated and projects should now be using stestr directly
for running tests.

Change-Id: Iad8911d6eb352c6e5b3b9fdcda6e9280b7efb5de
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-05-29 10:48:28 -05:00
Sean McGinnis 1af2c91e41
Unblock gate failures
There are a few issues causing all gate runs to fail that are addressed
in this patch.

Update constraints to match global requirements:

There are a few local requirements that conflict with what is now in
upstream global-requirements. This updates sphinx to match the
constrained versions due to incompatibility with py2 and uncaps
jsonschema.

Update handling for falcon 2.0.0 behavior changes:

The 2.0.0 release of falcon changed the default values for two request
query parsing options that would cause failures due to unexpected
results. This sets those options to their previous defaults to maintain
compatibility across 2.0.0 and pre-2.0.0 versions of the package.
Lower constraint version raised to 1.1.0 where the options were
introduced.

There are additional integration test failures with Falcon 2.0.0 that
were due to changes in the subscription URL path.

Closes-bug: #1830903

Requirements and upper constraints not enforced in some tox targets:

The docs and api-ref tox targets were not setting the right dependencies
or the upper constraints to use for pip installs. Also updates the
constraints to the newer preferred static redirect URL maintained by the
release team.

Co-authored-by: wanghao <sxmatch1986@gmail.com>
Change-Id: I19c5363878c629a04e1be902c865ee7cea92dcd9
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-05-29 09:31:18 -05:00
melissaml e4aca92889 Rename review.openstack.org to review.opendev.org
There are many references to review.openstack.org, and while the
redirect should work, we can also go ahead and fix them.

Change-Id: Ia40bcfa37709963ba84e78843ca27f153034c748
2019-05-12 04:52:10 +08:00
Frank Kloeker d4730fa60b Fix Sphinx formating errors
Change-Id: I7504ec70f22dbbd014873fa64eaee8fcba11397b
2019-04-20 23:35:35 +02:00
Ian Wienand 573fcc4881 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: I116cf26bfd65f0f45f64115678bc3f34d12d0d62
2019-03-24 20:36:27 +00:00
sanoojm 813663bc03 The instructions on README.rst to create a sample queue was outdated.
Change-Id: Ib5a920dcb0f2da3b8997d280837d18de432bfaba
Closes-Bug: #1439568
2019-02-11 08:08:12 +05:30
Zuul 2d96d9835a Merge "Update mailinglist from dev to discuss" 2018-12-24 11:32:27 +00:00
whoami-rajat 37fc134d11 Add zaqar-status upgrade check command framework
This adds basic framework for zaqar-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: I855b4b72284df308c3bb250fd3a3f0fc643b4abf
Story: 2003657
Task: 26165
2018-12-12 06:08:06 +00:00
Jonathan Herlin 3dbdeead38 Update mailinglist from dev to discuss
openstack-dev was decomissioned this night in https://review.openstack.org/621258
Update openstack-dev to openstack-discuss

Change-Id: I115c89897b5afa687b4f4a1cea6257b5ee2419c6
2018-12-11 11:18:58 +00:00
zhangdebo dd0c1f7fc9 Update link for blueprints of zaqar-ui
Change-Id: I9c0c179662734faa5d7c83e663f831c6ebf1f92c
2018-10-01 22:47:58 -04:00
xywang b926235153 Fix lower constraints job
Change-Id: Id1d406442f1a59474cfa6c96eb99bddecfe1c163
2018-09-13 14:38:06 +08:00
Zuul 55974a135d Merge "Update the Bugs link for triage" 2018-06-29 10:00:11 +00:00
ZhijunWei 29e288c115 Update the Bugs link for triage
This content has been moved to [0]

[0]: https://docs.openstack.org/project-team-guide/bugs.html

Change-Id: Ia902c3cb15fad69d2db54d358b07897b6eac7dcc
2018-06-28 05:55:37 +00:00
Zuul 788d57ed41 Merge "CONF file structure refactor" 2018-06-22 05:03:56 +00:00
xywang a7df08deb9 CONF file structure refactor
This is the openstack governance goal that the config files should
be merged into one folder to make the code to be better understood
and managed.

Change-Id: I33dd85145d9f5b0384323ffa51b4d68de0aeb5b7
2018-06-04 09:11:46 +08:00
Nguyen Van Trung 5d26144664 Remove ignore D000 in validation code
This commit going to remove --ignore D000 which had raised
alot of issues, such as:
- "D000 Cannot analyze code. Pygments package not found."
- Cannot check LOG which have '_' symbol in code-base.

And they also fixed in https://review.openstack.org/#/c/568729/

Change-Id: Ic5258e0262c11b9f878d867a3354aa7d1f6e67b4
2018-05-30 10:33:36 +07:00
wanghao fe87830da2 Make doc more clearness
Now when running functional and unit tests, if user wants
to use a custom MongoDB instance, he needs to set
two environment variables: "ZAQAR_TEST_MONGODB_URL" and
"ZAQAR_TEST_MONGODB".

Change-Id: I98fe958bfb4fb7f3913de0d0bdc2490f3b441f1b
2018-05-29 15:36:11 +08:00
inspurericzhang a40294984b 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: Ia98c598c48efd0ec8c5c6fbb3b37ad6604664f3f
2018-05-25 15:17:00 +08:00
xywang 17ef71a482 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I444cdaad0d83d9d8795dc03793aefe2fa3a51203
2018-05-22 06:12:22 +00:00
liuyamin 2085162247 Update auth_url in install docs
Beginning with the Queens release, the keystone install guide
recommends running all interfaces on the same port.So this patch
updates the install guide to reflect that change.

Change-Id: I8b1c290c9dcfb721946b6052da4c14f5bf00378e
2018-05-08 10:25:01 +08:00
melissaml 7b8776e483 Update auth_uri option to www_authenticate_uri
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

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

Change-Id: Ieff5b69018e3824074b5a528a7b9d2a00dd7fb2e
2018-04-18 19:15:13 +08:00
Nguyen Hung Phuong 5a8b084401 Nit update in jenkins.rst document
zuulv3 has been replaced by zuul so the document should be updated
in file:

doc/source/contributor/jenkins.rst

Change-Id: I38d7b843718d5d3a6e6c3881fa3016c54913ed59
2018-02-13 10:44:29 +07:00
gaofei 3d99504e27 Replace curly quotes with straight quotes
Curly quotes usually input from Chinese input method.
When read from english context, it makes some confusion.

Change-Id: I7224650e2a52e813077bb84ad3ceddb9d87f934e
2018-01-25 03:42:31 +00:00
yangzhenyu 6801ce8ff6 Update the install guide about policy json file
Since the policy json file has been removed. So the
installation guide should also be updated.

Change-Id: Ibf158e402fa31702fadf70f27d5db5a5d6814e34
2018-01-15 16:48:39 +08:00
Zuul 27ece69e8d Merge "Update the documentation link" 2017-12-04 03:50:23 +00:00
gengchc2 dfdd829ff0 tox -e docs: Line too long
Change-Id: If90cc4b8745ed3f5c98ed69673bb7d2bd4b687a6
2017-12-03 21:16:44 +00:00
Guoqiang Ding b7093a3a4c Update the documentation link
The documentation about "ops-guide" has been moved.

Change-Id: Id195831399594631cca0457fc6bc6f0e6805ccf5
2017-12-03 21:16:05 +00:00
Vu Cong Tuan d170c6fd57 Do not use “-y” for package install
According to "code conventions" [1], do not use "-y" option.
Instead, use apt-get install package, yum install package,
or zypper install package.

[1] https://docs.openstack.org/doc-contrib-guide/writing-style/
code-conventions.html

Change-Id: I58d11d0bb8976941ceda56a95112783090d211bf
2017-11-08 14:41:24 +07:00
Zuul 0505f5ee51 Merge "Add more backoff functions" 2017-10-27 11:01:42 +00:00
gecong1973 ef8631899e Add more backoff functions
This patch introduces more retry backoff function the delivery 
retry policy into Zaqar. It will work when Zaqar failed to send 
the notification to the subscriber. Users can define the retry 
backoff function in the options of subscription or metadata 
of queue.

Change-Id: I0bffd9249f8a0d466ecea1ac36d8adc37b742238
Implement: blueprint support-more-backoff-functions
2017-10-24 01:01:47 +00:00
Nguyen Van Trung ffd58efb1e Move to Zuulv3 link to check status
Change-Id: Idf4888167b25375e206cf84da61764e535d608ef
2017-10-20 14:55:54 +07:00
Rui Yuan Dou eb86aafb23 Correct descriptions of install doc
1. add create pid step
2. correct service config file name to 'zaqar-uwsgi.service'
3. move zaqar.conf into /etc/zaqar/
4. change uwsgi workdir to path '/srv/zaqar'

Change-Id: I6aafbb3b84abaf3ae40561055c2c122d9a1c8dff
Closes-bug: 1716864
2017-10-17 22:27:42 +08:00
Jenkins 96a0aac2e8 Merge "Correcting typo on doc." 2017-10-09 18:32:15 +00:00
mohit.mohit2atcognizant.com 31a6325b00 Correcting typo on doc.
Fix for typo in zaqar documentation -:

  * Ref doc link - Doc Link - https://docs.openstack.org/project-install-guide/messaging/newton/verify.html
  * There is typo in string  "X-Auth-ToKen:
  * Instead it should be "X-Auth-Token:
  * This patch fixes the typo for letter k in string Token

Change-Id: I6644b2601754914166d29cf1e1af98f8e8f265e8
Closes-Bug: #1718414
2017-10-09 09:24:45 +00:00
mohit.mohit2atcognizant.com 04a983756d Adding folder path
Fixes the zaqar documentation
 * Ref to Doc Url - URL: https://docs.openstack.org/zaqar/latest/install/install-ubuntu.html
 * It is not spelled to copy the files on /etc/zaqar
 * Later on it is mentioend to copy the sample policy.json file to /etc/zaqar
 * Adding the root folder path for it on the string "sample file to the directory etc/zaqar/:"
 * It is mentioned to make a directory but the directory name and path is missing.
 * As per the above we have to create the directory "/etc/zaqar"
 * This patch would update the missing folder path on the documentation.

Change-Id: Ib538857ef0abef9617d44e3f803b4bcd191bc546
Closes-Bug: #1718366
2017-10-09 09:10:31 +00:00
wangxiyuan 02c49fe3f7 Remove "enabled" in CORS guide
The "enabled" config option has been removed already.

Change-Id: I35586d11e93b6d62513738dd6263e6fe1032d2af
2017-09-08 10:46:31 +08:00
shangxiaobj b2d9b90499 Replace http with https for doc links
Use https instead of http for docs links.

Change-Id: I46b16918995a89d2ec68a5d3124fc7db53228e54
2017-09-03 20:12:49 -07:00
Rui Yuan Dou eec827b565 Correct typo of zaqar index doc page
Change-Id: Iefc7c07effb2e05a2c11a06cbe835f11f3932df9
2017-08-23 17:24:13 +08:00
Jenkins 0d3ea781ca Merge "Update and optimize documentation links" 2017-08-10 23:22:14 +00:00
liuyamin 49a397ebfb Use doc8 check
doc8 is a linter for documents and used in openstack-manuals. It is better to
enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
- Trailing whitespace

Change-Id: I328e2b2b82739696b95eca4a4130ca347893b0dc
2017-08-10 09:07:41 +08:00