56 Commits

Author SHA1 Message Date
Pino de Candia
2f684da0aa Initial and incomplete conversion from designate to tatu. 2018-01-25 02:42:29 -06:00
OpenStack Proposal Bot
65cc292267 Updated from global requirements
Change-Id: Ic6c3f0454bcc103d583e28c49c2d7fdbc7aa5816
2018-01-24 01:28:11 +00:00
OpenStack Proposal Bot
699562b9f4 Updated from global requirements
Change-Id: I273c1bef643207929cbd5733d93ebf999d3e7132
2018-01-18 03:27:02 +00:00
OpenStack Proposal Bot
2f08b284ba Updated from global requirements
Change-Id: Ie5e0096cdd95eb58ff07b2b3f1d6c0bdde3a4eae
2017-12-19 01:41:42 +00:00
Monty Taylor
853dbddc22
Split doc requirements into their own file
We don't need sphinx in the test virtualenvs, but we do need it for
docs.

Change-Id: I8ae98d08090e2e391ba725ddd5ff0125a03c8d47
Depends-On: Ie0c9f24df09255e871f904e079b68809144b36b4
2017-12-18 14:44:25 -06:00
Jens Harbott
90726f9b3b Remove unneeded requirements file
Need to make requirements-check non-voting in order for this to pass,
will undo that afterwards.

Change-Id: I939ef1da660e939fe0ff9c6eaa4919e3e1d21fee
2017-12-07 14:19:53 +00:00
Hangdong Zhang
8763100955 Update and optimize documentation links
1. Update URLs according to document migration
2. Update the dead and outdated links
3. Optimize (e.g. http -> https)

Change-Id: I426747fbeb2277a5cddacf589234c0fdcfc5d673
2017-07-19 10:50:25 +08:00
Doug Hellmann
cbc8503d20 switch from oslosphinx to openstackdocstheme
Change-Id: Idd2542a0be57e9ed52718654649f945b85c4ed0a
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-10 11:50:21 -04:00
Doug Hellmann
3947730ed5 import cli-reference material from openstack-manuals
Change-Id: Ida7c2fb3f987aa2cef5f2eaba52f36413547de71
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-10 11:50:21 -04:00
Doug Hellmann
3241a7d9c4 rearrange the existing docs into the new standard layout
Change-Id: I1cf25aade215aad3ce9050af7c9fa8987564863c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-10 11:50:21 -04:00
Graham Hayes
4e7b853e30 Update cli docs
Marked V1 API docs as deprecated
Moved to "example.(org|net|com). domains
Removed servers cli examples (as they are now dangerous with v2 API)

Change-Id: I3e1fa170dc189cc5dac608a9aecacd9127a2233e
2017-07-10 11:54:00 +01:00
Stephen Finucane
b2f8e3cfc4 doc: Remove cruft from conf.py
Change-Id: I2cdb0c7ed4b7ef9deb12454fe2fe7361edc9438c
2017-04-20 13:57:40 +01:00
Stephen Finucane
6b7b018cb6 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.

This involves a couple of changes to the docs to fix the now broken
build.

Change-Id: I9bee7f6f9c69a9ed7bb22325ad1a0a1316dde526
2017-04-20 13:57:16 +01:00
Tim Simmons
8d806158ae Simplify OSC doc structure
This page should be linked from the main docs as a place to see the
various commands that are possible. This moves the more verbose
examples to one place and delete the other page. There was also some
grammar that bugged me so I changed it

Change-Id: I8bc23e493794a43d7f6eb4d5bd5dce965c8ff11d
2017-02-23 15:26:04 +00:00
sonu.kumar
5f23b4bdcc Fix broken link for modindex
The documentation build does not generate any module index,
therefore modified setup.cfg to create module index.

Change-Id: I6140896d5779e8360c866267601713bbf572fee4
2017-01-26 23:55:57 -05:00
ashish-kumar-gupta
64292094d7 Fix for bug 1627945
Documentation doesn't specify that admin credentials are needed to zone abandon

Change-Id: I3f3d2ae35824bcffa285878629fd4a841c0cf602
Closes-Bug: #1627945
2016-10-13 10:39:53 +05:30
sonu.kumar
335ecfcdb3 Docs update for FloatingIP's ptr records
Change-Id: If6e7dd77d43bc541a7e872b7fc6964874e3f3463
2016-08-08 12:08:06 +05:30
Jenkins
f5a49f2787 Merge "Allow cli to query "v2/recordsets"" 2016-06-29 16:19:04 +00:00
sonu.kumar
8bc106654c Add openstack zone transfer accept list cli to designateclient
This patch add cli for listing accepted zone ownership transfer

and corresponding test cases.

Related-Bug: #1499539

Change-Id: I3eec36c73b2dacd4eed3b8578c4d51593b43104d
depends-on: I3dc042f666be43649bb3dec6e92cc67d1c32578f
2016-06-14 11:26:53 +00:00
Graham Hayes
eedd4ac142 Allow cli to query "v2/recordsets"
The allows users to list all recordsets in the system.

running ``openstack recordset list all`` will show all rrsets

Change-Id: Id47961c80484550c99c1834a554afe31165b69ca
2016-06-09 20:19:05 +01:00
Dougal Matthews
5d4ca42311 Use the correct capitalization of OpenStack
Change-Id: If02429ed7254e4cd543b2f22f7685bf045fb4cd6
2016-05-18 11:45:23 +01:00
Jenkins
11416b4726 Merge "Update doc examples to use keystoneauth" 2016-05-11 09:24:51 +00:00
sonu.kumar
22ca41913b Docs Update
This patch updates docs for v2 cli examples.

Change-Id: I2e8c7e8259ce8b3e446e33862e1c8a57b0cf3690
2016-05-10 06:23:32 +00:00
Clenimar Filemon
69f4597bf1 Update doc examples to use keystoneauth
As keystoneclient's Session and auth plugins have been deprecated in
favor of keystoneauth, the documentation examples must reflect that.

This patch updates all examples in order to show keystoneauth Session
usage instead of deprecated keystoneclient Session. Also, the python API
bindings were updated too.

Change-Id: I4b64fee4f526cc5b4a5e36cc8edb61164ceded51
2016-05-06 21:06:04 -03:00
Reddy A, Penchal (pr8721)
5ac063eba3 Update designate cli page with more examples
Closes-Bug: #1578207

Change-Id: I775e12510b0705e8ab797bf34e9b38d4853e65c1
2016-05-06 09:39:57 -04:00
Rahman Syed
d4a5555e52 Improve python-designateclient docs
* Improve index page to explain the difference between v1 and v2
  CLI support.
* Add a v2 examples page
* Add all supported commands to v2 shell page
* Add a tox task to build the docs
* Fix a bug building the docs with an invalid html_static_path
  config

Change-Id: Ie1e65c2d0cc8ad1b8b258e03114e19a943d1d19c
Closes-Bug: 1572217
2016-04-20 11:57:57 -05:00
Venkata Mahesh Jonnalagadda
318048df4b Doc changes for installation webpage
Change-Id: I8dba20b06680262ecd67df7165bd5ec0baed97a2
Closes-Bug: #1563865
2016-03-30 12:03:59 -04:00
Andrew F. Ly
3f18b79b5d Fixed grammar mistake in shell.rst
This trivial commit fixes a grammar mistake in the documentation.

Change-Id: I0e2a8bf75bf1f5a1bc1f64cc59e0c4ab4e67dbaf
Closes-Bug: 1536369
2016-01-20 15:04:57 -06:00
Jenkins
524f93d79d Merge "Fixes doc for v2 cli" 2015-11-04 21:43:41 +00:00
sonu.kumar
793cdee2ad Updates shell doc of v1 client
This patch updates shell doc of designate v1 client.

Closes-Bug: #1511672

Change-Id: Iaa35b4fa97e0a3680769c0942a51c28e7cede2fc
2015-11-04 14:51:02 +05:30
sonu.kumar
02f23f2d43 Fixes doc for v2 cli
Change-Id: I7994d3d0ea8ff1fd0f6471f05a1c35d1f4920d9d
Closes-Bug: #1511225
2015-10-30 10:36:55 +05:30
Jenkins
f2192badc1 Merge "Layout some functional tests for the V2 CLI" 2015-09-24 08:40:02 +00:00
Paul Glass
6daf82777e Layout some functional tests for the V2 CLI
Change-Id: Ib2d1261bcb0362c586c0aae4b9c5a8a563f07c71
2015-09-23 14:30:35 +00:00
Jenkins
9803b87a31 Merge "Implement socket timeout in v1" 2015-09-08 13:40:16 +00:00
Jenkins
52d68e5b19 Merge "V2 CLI Support" 2015-09-02 17:07:12 +00:00
Endre Karlson
f7d4dbbff5 V2 CLI Support
Change-Id: I583fc864bb4aa8b4dd2d965c2f8c1f3f6d31dd8c
2015-09-02 15:54:08 +02:00
algerwang
83d4cea57f Update github's URL
Old URL is https://github.com/stackforge/python-designateclient
    or git@github.com:stackforge/python-designateclient.git.

But now is https://github.com/openstack/python-designateclient
    or git@github.com:openstack/python-designateclient.git
Closes-Bug: #1486337

Change-Id: I1f3d0b90b22295ad9cce9c2f05d9993935d07f70
2015-08-19 18:31:49 +08:00
Federico Ceratto
2ec96b6672 Implement socket timeout in v1
Add endpoint_override keyword to v2.Client() and check for the
session argument in DesignateAdapter()
Add unit test, fix minor typos

Change-Id: I038ec7b0d1feadc9642bd47285e397b3fe84c13c
Closes-Bug: 1469739
2015-08-11 18:36:56 +02:00
sonu.kumar
866114dbf6 Replacing print with print() to provide py 2/3 compatibility
Replaced print in python 2 to print() to provide py 2/3 compatibility

Change-Id: I805ecdbdd07ea89c1595c045fc5b380f9bb42335
2015-07-20 15:01:42 +05:30
Simon McCartney
f9e41ea81e Removed peronal email address from example
Change-Id: I2ca31701af37ab9776e86aa7ce16f86f6edc8557
2015-06-25 14:30:19 +01:00
Andrew Spiers
2c8492f2f6 Update github link
Change-Id: I5d27500d125b9c1424ca71a9e112079d1939ba75
2015-06-02 12:44:42 +10:00
Joe Gordon
6ed6b0f36b Drop incubating theme from docs
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.

Change-Id: Icf6d89805db56a4f695ac55e6630b804f26655f8
2015-05-27 15:24:06 -07:00
Endre Karlson
2a2c85ce21 V2 Bindings
This provides bindings for:

- zones
- recordsets
- tlds
- blacklists
- limits
- nameservers

With associated unit tests.

Change-Id: Ie9b79340bd327b78916fd038633842da3ace881b
2015-05-07 17:23:09 +02:00
Jeremy Stanley
e20b1d3f84 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ia1631b026e1d59e9e4b448bb2c96c8cf4c6e3421
2014-12-05 03:30:39 +00:00
Alok Jani
332ea6fc27 Fixes homepage in metadata and internal docs
* Correct homepage in package metadata file
* Correct launchpad & GitHub home in contributing.rst

Change-Id: I01e1cf7f97a72b78d4c26543b73910ac6a90e145
Closes-Bug: #1332626
2014-09-26 14:24:10 +05:30
Graham Hayes
f3685e67d1 Added oslosphinx theme, and enabled the incubating option
Change-Id: I0bb22dc0a53a9db169a07e305cd4aeab317b2d7e
2014-07-16 00:20:41 +01:00
Kiall Mac Innes
e6ff6884d4 Correct Python bindings create-record example
Change-Id: Ic4dee73aa7c0f407fa3fd757edf52a923ba5707d
2014-04-14 19:28:59 +01:00
Kiall Mac Innes
11d4b42c11 Standardize doc requirements
We now match the other projects

Change-Id: Iec54b97eadf4487a31eac1690d24de3fcfebc1da
2014-03-04 21:36:02 +00:00
Graham Hayes
e2d7dc2c5c Added domain and record description editing
Change-Id: I8cdf3b9fa986255a9c1787f4ed8375bded8ee062
Closes-Bug: 1213889
2013-10-30 18:41:06 +00:00
Kiall Mac Innes
d1e24a90c5 Correct two Record examples in the binding docs
Change-Id: I73df92ab161a3f6dacb196d827130de8f7ae8252
2013-09-25 15:16:35 +01:00