362 Commits

Author SHA1 Message Date
melissaml
794dea3817 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: Ic7dad29922af2efed2188f3215f364719f0e19ae
2018-03-27 10:30:57 +08:00
Erik Olof Gunnar Andersson
6ad30a39e6 Remove translation of log messages
* Removed all log translation.
* Always lazy-load logging.
* Fixed broken log lines and updated tests.

Logs should no longer be translated (starting with Pike)[1].

Also, according to OpenStack Guideline[2], logged string message should be
interpolated by the logger.

[1]: http://lists.openstack.org/pipermail/openstack-dev/2017-March/thread.html#113365
[2]: https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html#adding-variables-to-log-messages

Change-Id: I07825694f173a8bebd7d62ade089c38d3c666283
2018-03-14 12:54:05 -07:00
Zuul
65104a1a91 Merge "Remove empty files" 2018-02-24 12:13:44 +00:00
Nguyen Hung Phuong
41a6c860c0 Remove empty files
doc/source/_static/designate-docs.css
is empty file. We probably should delete it.

Change-Id: I9d3d3e4c42e841abc9599eba81a3b6d7d9cb1a2f
2018-02-22 17:47:24 +07:00
Thomas Goirand
ed69c37962 Fix unicode not define in doc with py3
Under Python 3.6 in Debian Sid, I couldn't build the sphinx doc, and this
patch fixes it. It replaces unicode by six.text_type.

Change-Id: I538f10ef297fb45cb82e47f5bcb86ed214a062b0
2018-02-18 11:52:13 +01:00
zhangdebo
f8e5c0af8e Correct link address in docs
Link address for "DNS Server Driver Support Matrix" is out of date,
so correct it.

Change-Id: I2584ca26b3ab24e3ac44db2e5a1d5ecb3599117e
2018-01-29 14:22:04 +08:00
Graham Hayes
c318106c01 Remove v1 API
This completes the long awaited removal of the V1 API.

Change-Id: I30c8a5e8569b1b86286c5e3cb07856c06ebe5803
2018-01-11 14:13:43 +00:00
Zuul
f83addc827 Merge "Docs Refactor" 2017-12-18 16:49:30 +00:00
Graham Hayes
26d6298b97 Remove unneeded requirements file
Need to make requirements-check non-voting in order for this to pass,
will undo that afterwards.

Change-Id: Ibc77ea864503e63f73be0f1c41e07bfe8ea3dcae
2017-12-07 14:12:04 +00:00
Graham Hayes
3955f474a5
Docs Refactor
* Move backend docs to admin guide
* Add oslo.config sphinx extention
* Add HA guide
* Update drivers to log driver grade

Change-Id: I4a364a0d1a0656f26d3a4c3b7baad7e43cddcb16
2017-12-05 21:06:18 +00:00
Jens Harbott
ca7da3dcd8 Update installation docs
- Replace keystone_authtoken section with v3 style parameters
- Update Ubuntu doc to reference current LTS release
- Update Ubuntu doc to use systemctl

Change-Id: Ic1dedb04b08e09eda3d7772846eadeb7aa22fbb2
Closes-Bug: 1734635
2017-12-04 06:44:15 +00:00
Nguyen Van Trung
154d12114f Add validation to improve pep8 check for designate project
This PS will help project avoid pep8 some issues for *.rst
in whole project.

Co-authored-By: Hoang Trung Hieu <hieuht@vn.fujitsu.com>
Change-Id: I7a01863b1aa0bcf999be6e6e2261ab35530c196a
2017-11-20 12:26:16 +00:00
chenxing
94f177376a Revise the Installation Guide structure
Change-Id: I6552d1b41241bd4d0b69c676f28ee81f3fcf0b6e
2017-11-17 09:29:34 +00:00
Zuul
f431074db5 Merge "Update PTR Record example" 2017-11-17 03:33:33 +00:00
Zuul
e1998ccfd3 Merge "Update devstack.rst" 2017-11-16 17:56:58 +00:00
caowei
c6f696b5b1 Update devstack.rst
* Remove screen sessions
* Add querying-logs
* Update openstack cli

Change-Id: I6897443464e2b4257e10ba4951a4c91002f4372a
2017-11-16 12:29:00 +08:00
caowei
12a03e8874 Add kolla installation guide
Change-Id: I502e936f184221d9c571d5ffb1c4c46ab191d013
2017-11-16 10:48:03 +08:00
caowei
821620167b Update PTR Record example
* 192.0.2.12 --> example.org.
* example.org. --> 192.0.2.12
* RPC 12.2.0.192.in-addr.arpa.

Change-Id: I609983a5f66614aeba36da63ac9a8446c70b4e18
2017-11-14 10:42:59 +08:00
Graham Hayes
95f80e4c0a Add Docs for the policy in code work
Change-Id: Ie097e5b48f5e42c9c30efdb2d6d9a6aa9e65387c
2017-10-26 17:06:35 +07:00
Ben Nemec
46de766e51 Dev docs cleanup
A few minor issues I noticed as I was going through the development
environment setup.  Fixes a typo and replaces deprecated config opt
references with the new ones.

Change-Id: Ib094595153e9b74706304f8328de74d07649b817
2017-10-03 16:29:12 +00:00
Andreas Jaeger
8026cb95f1 Fix broken /developer/ links
Fix links that have changed with recent doc reorg.

Remove link to designate-msdnsagent, the repo is retired.

Change-Id: I22f78c3ed4ca723a46f9f9b4f83f80ed93bab72e
2017-09-07 20:25:29 +02:00
Jenkins
4fb94a0844 Merge "writing convention: do not use “-y” for package install" 2017-09-06 22:29:43 +00:00
Jenkins
41d4ee6561 Merge "Fix to use "." to source script files" 2017-09-06 22:29:20 +00:00
Jens Harbott
7874aa1eb3 Update docs formatting
Allow the sidebar TOC to actually contain the sections that we have
here.

Change-Id: Ieb9eb0a9a532397c36812bdffe6f2962aca7448a
Related-Bug: 1713081
2017-09-05 11:19:30 +00:00
chao liu
ff6745edff Fix to use "." to source script files
Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: I8aa81956e9fd50d9739ddaa178581c7eabedb826
2017-08-28 13:51:39 +00:00
chao liu
8cc1d6f631 writing convention: do not use “-y” for package install
refer to:
https://docs.openstack.org/contributor-guide/writing-style/ \
code-conventions.html

Change-Id: I7d4bbbe3a15a2793b7b398f6ee7c2a0b9e72caa5
2017-08-28 01:36:06 +00:00
Nguyen Van Trung
dba2a8bc78 Improving the designate topology.
Based on code-base, we should need correctly communication of producer,
worker along with central services following items:
1. Producer and Central.
- The producer will call Central via RPC as following code-base:
       self.central_api.purge_zones(
            ctxt,
            criterion,
            limit=self.options.batch_size,
        )
2. Worker and Central.
- The worker will call Central to get pool via RPC firstly:
       pool = self.central_api.get_pool(context, pool_id)

Change-Id: I9c98c2c1fb441a333bc8d917e122a4e0371ef7ce
2017-08-21 09:39:41 +07:00
Nguyen Van Trung
edc0684ace Improve and update docs
- Update install-guide.

Change-Id: Ic27e27b4653efee35004457a843e2afb7786b5b0
2017-08-03 08:41:54 +07:00
Jenkins
ab9ac5b0cf Merge "doc: Populate the 'install' section" 2017-08-02 18:17:22 +00:00
Jenkins
fc5e8d2545 Merge "doc: Populate the 'configuration' section" 2017-08-02 18:17:12 +00:00
Nguyen Van Trung
933917cc25 Fix a integrations doc link
Change-Id: I763983314f4341b36d88fb5fc32da97746fd6e91
2017-07-31 16:53:03 +07:00
Hieu LE
66c873a67d doc: Populate the 'install' section
Per the spec [1]:
   install/ – anything having to do with installation of the project

The current install guide need to move to this category.

Change-Id: Ib2005a7ed7c3d476b3e4e2a3603736203af8b415
Implements: blueprint designate-doc-migration
Closes-Bug: #1706173
2017-07-25 09:35:15 +07:00
Hieu LE
3f1fe07d06 doc: Populate the 'configuration' section
Per the spec [1]:
    configuration/ – automatically generated configuration reference
    information based on oslo.config’s sphinx integration (or manually
    written for projects not using oslo.config). Step-by-step guides for
    doing things like enabling cells or configuring a specific driver
    should be placed in the admin/ section.

Only the sample_config file fit into this category at present.
Let's add new sample_config file and move the configuration section to
this category.

Change-Id: I789fe53f4df9409dd6e4a6d5f9280feb65792258
Implements: blueprint designate-doc-migration
Partial-Bug: #1706173
2017-07-25 08:36:01 +07:00
chenxing
bc24df1ee2 Update the documentation link
Change-Id: I28e9097f01e4e6d60093c34534f58299488ebf73
2017-07-14 05:24:26 +00:00
melissaml
11f4a3c9dd Update URLs in documents according to document migration
Change-Id: I96d83374cfc2bdde92cb24f5a44c358fca6f8736
2017-07-13 15:32:08 +08:00
Doug Hellmann
e940a65e23 complete the migration from oslosphinx to openstackdocstheme
Change-Id: I32bbd44df176397d6887a4547cbf71b819daa358
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:44:36 -04:00
Doug Hellmann
84040e07ed rearrange existing documentation according to the new standard layout
Change-Id: I797d2445b16c8348cdbafbb4f859251c772e1e14
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:44:36 -04:00
Nguyen Van Trung
f7e8a71b02 Improving check warning build_sphinx
- With this PS, we could be received a warning error at same time
when build sphinx decumentation of Designate via:

    $ python setup.py build_sphinx

- Fix some issues with docs sphinx.

Change-Id: I1e5a8c4b45dc3d10028531eabb50d3d6189ea070
2017-06-12 13:55:18 +07:00
Ngo Quoc Cuong
737937d677 Trivial fix typos while reading doc
Change-Id: I5b36bde74aeafdbb12fb5635b377e6232c32e80c
2017-05-22 08:27:25 +07:00
Alexandra Settle
116b62411e [docs] Rearranges index.rst to build nicer with the theme
Change-Id: I80908be1effc160e6b823dd343d315455bc1f352
2017-04-27 09:37:42 +00:00
Tim Simmons
8f4adefbed Make Pools documentation better
Moves a bit that was generally helpful out of a how-to
guide onto the main pools doc page.

Change-Id: I952b8e57f332fcbb727faf1bf9244d8fe6ae297c
2017-03-14 20:51:17 +00:00
Jenkins
f48feafccd Merge "Switch to the OpenStack Docs Theme" 2017-03-13 15:15:29 +00:00
Tim Simmons
2f57bdc8eb Switch to the OpenStack Docs Theme
Updated the theme, added some custom css for the
backends matrix, and moved the toc to the sidebar

Change-Id: Ibb7860d9ddc16e5d81e127c8713c810122c2c25f
2017-03-13 10:59:59 +00:00
Tim Simmons
8d1698e044 [docs] Add missing upgrade guides
Get some much-needed upgrade guides in for past releases

Change-Id: Ia2533283618f15a04437c682a8fd778e4c8613c6
2017-03-09 21:10:32 +00:00
Graham Hayes
2508c8e333 Move docs to tempest plugin repo
Change-Id: Ic2122ddf2232c9ff382bc8276fbf2b7c4d09326b
2017-03-08 16:15:48 +00:00
Tim Simmons
50c3a46964 New Docs toctree
With the goal of making these docs more useful, asettle helped
us out creating a new tree at the PTG:
https://etherpad.openstack.org/p/designate-ptg-docs

This is the implementation of that new tree. With some minor changes
to content. There's still a lot of work to do there.

Change-Id: Idb29c04cde298a32da430243ae62894e1a790176
2017-03-08 02:40:02 +00:00
Tim Simmons
9d39448ab2 [doc] Update Ubuntu dev environment doc
Get the dev doc up to date, and delete some old ones that are
outdated.

Change-Id: Iee2c117b2dff6a5d9fcf486d201da32773055dec
2017-02-28 14:29:07 +00:00
Jenkins
ce43cecfc8 Merge "Update Architecture Doc" 2017-02-28 13:49:14 +00:00
Jenkins
0b4926f974 Merge "Add basic information on sink + neutron" 2017-02-27 20:54:10 +00:00
Jenkins
54f5f177ed Merge "Point Users at the main install guide site" 2017-02-27 20:54:04 +00:00