344 Commits

Author SHA1 Message Date
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
Jenkins
7a95efc437 Merge "Add note for running designate-tempest-plugins" 2017-02-27 20:17:39 +00:00
Tim Simmons
d67a33e017 Update Architecture Doc
Add new services and update descriptions, add a high-level
description of what Designate is.

New picture: http://i.imgur.com/UlDJi3t.png

Change-Id: I5750547486c2b69241c034a48940d8f28a7a3e56
2017-02-27 20:10:18 +00:00
Jenkins
ebbaa32440 Merge "Remove old docs content" 2017-02-24 18:49:26 +00:00
Tim Simmons
3765eb4902 [docs] Merge Developer Guidelines into Getting Involved page
This just moves the dev guidelines into the Getting Involved page,
in preparation to get it moved up and be one of the first pages for
folks to read.

Change-Id: I1eabfa80154dedcf2036fd27c49c082e82e7513a
2017-02-23 19:21:32 +00:00
Graham Hayes
83d1b25c1c Add basic information on sink + neutron
Change-Id: Ib840297139e79d9270d3b014cb9181ba428199de
2017-02-23 10:47:46 -05:00
Graham Hayes
e435d6adb5 Point Users at the main install guide site
Change-Id: I634d62e870333e996b7cd981c577ae7196959e02
2017-02-22 14:58:56 -05:00
Graham Hayes
f7fcec6c4a Remove old docs content
Change-Id: I5289d75f4bd0d9c1489a208e3d83ac4f44c9422d
2017-02-22 14:55:29 -05:00
Tim Simmons
fe318c2ec3 Add note for running designate-tempest-plugins
It's not trivial to run tempest plugin tests if you don't
set things up exactly right, this explains an annoying
nuance to make it easier.

Change-Id: I759cb747504cf47548ae4460ffa67ba62c49024b
2017-02-21 21:31:53 +00:00
Jenkins
6bab307396 Merge "Added in doubt default pool filter to scheduler" 2017-02-16 17:52:32 +00:00
Maurice Schreiber
df73f7331b fix tox -e docs errors
Change-Id: I516e28cefbfe041085a547ed9b601c3aa1541ce8
2017-02-16 10:27:30 +01:00
Maurice Schreiber
4f3dfff564 Added in doubt default pool filter to scheduler
If the previous filter(s) didn’t make a clear selection of one pool
and if the default pool is in the set of multiple pools,
this filter will select the default pool.

Change-Id: I26a7a2628bcb593c189d8b470fd546c060ceeab9
2017-02-14 16:15:53 +01:00
Jenkins
8cbd3ec843 Merge "DOC Remove a couple of repeated words" 2017-01-30 18:10:23 +00:00
ghanshyam
1c7acc2401 Switch to decorators.idempotent_id
test.idempotent_id is being kept temporary to migrate
to new lib interface. Now idempotent_id is available as Tempest stable
interface decorators and all plugins tests using the old decorator
should be switched to new interface.

In future, Once all plugins are switched to new decorator Tempest
will remove the test.idempotent_id

This commit correct the example tests in doc.
Related-Bug: 1616913

Change-Id: I4c8eb461a04072403d5bf0e03cefae8df03999f0
2017-01-27 06:33:01 +00:00
Mike Carden
1ea6f5e3a7 DOC Remove a couple of repeated words
Remove words accidentally duplicated during editing.

Change-Id: Ic7e0dc245df4c5358dcebe72532f99604d8f27f7
2017-01-11 14:24:13 +11:00
Cuong Nguyen
5f973e808d Fix typo in upgrade doc
TrivialFix

Change-Id: I5eae5dbad052e8d21f585575c3da3b61380119b1
2016-12-27 11:27:59 +07:00
shihanzhang
ad47c16e41 Fix typo
Change-Id: I6b0ceaa97582508ce4f83344b858bd2363a03757
2016-11-04 16:40:46 +08:00
leiyashuai
89033f080b [Trivial] Fix some typos in designate.
Change-Id: I664b65d5c91b991b478c012955ccc1be94599c86
2016-10-26 19:31:07 -07:00
Jenkins
4d383a30e9 Merge "Fix Mitaka Upgrade Doc" 2016-10-19 17:18:03 +00:00