Update contributor docs

- Drop reference to weekly meeting
- Use https when possible
- Update comment about devstack plugin
- Need to use Ubuntu 18.04 or newer
- Change deprecated option in example

Change-Id: Icdff59fb24fde99b02b9d5e85e3b6d17d5f3434e
This commit is contained in:
Dr. Jens Harbott
2020-05-14 06:28:26 +00:00
parent 0f7c6adc0b
commit 577641e61e
2 changed files with 12 additions and 19 deletions

View File

@@ -19,7 +19,8 @@
How to install DNS with DevStack
================================
The Designate team maintains a fork of devstack with Designate integration.
The Designate source code contains a DevStack plugin that allows to deploy
an OpenStack installation with the DNS service enabled.
Instructions
~~~~~~~~~~~~
@@ -30,7 +31,7 @@ Instructions
using the contrib/vagrant folder in the
`repository <https://opendev.org/openstack/designate>`_.
1. Get a clean Ubuntu 16.04 VM or newer. DevStack "takes over". Don't use
1. Get a clean Ubuntu 18.04 VM or newer. DevStack "takes over". Don't use
your desktop!
2. Clone DevStack inside the VM::
@@ -97,7 +98,7 @@ Instructions
| version | 1 |
+----------------+--------------------------------------+
$ openstack recordset create --records '127.0.0.1' --type A example.net. www
$ openstack recordset create --record '127.0.0.1' --type A example.net. www
+-------------+--------------------------------------+
| Field | Value |
+-------------+--------------------------------------+

View File

@@ -7,21 +7,13 @@ Getting Involved
devstack
#openstack-dns
--------------
#openstack-dns IRC channel
--------------------------
There is an active IRC channel at irc://freenode.net/#openstack-dns,
where many of the designate contributors can be found, as
well as users from various organisations.
Weekly meetings
---------------
There is a weekly irc meet. The agenda and other details are listed at
`Designate meetings wiki page`_. Currently the meeting is
held every Wednesday at 17:00 UTC on the IRC channel
irc://freenode.net/#openstack-meeting-alt
Contributing
------------
@@ -59,7 +51,8 @@ Development Environment and Developer Workflow
Assuming you've already got a working :ref:`Development Environment`,
here's a quick summary:
Install the git-review package to make life easier
Install the git-review package to make life easier, some distros have
it as native package, otherwise use pip
.. code-block:: shell-session
@@ -134,9 +127,9 @@ Several common reserved IP blocks:
* 203.0.113.0/24
* 2001:db8::/32
.. _IANA Special Use Domain Names: http://www.iana.org/assignments/special-use-domain-names/special-use-domain-names.xhtml
.. _IANA IPv4 Special Registry: http://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
.. _IANA IPv6 Special Registry: http://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
.. _IANA Special Use Domain Names: https://www.iana.org/assignments/special-use-domain-names/special-use-domain-names.xhtml
.. _IANA IPv4 Special Registry: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
.. _IANA IPv6 Special Registry: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
Style Guide
'''''''''''
@@ -240,7 +233,6 @@ See https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html
LOG.error("... %(key)s", {'key': 'value'})
LOG.critical("... %(key)s", {'key': 'value'})
.. _Gerrit workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _Gerrit workflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _blueprint: https://blueprints.launchpad.net/designate
.. _bug: https://bugs.launchpad.net/designate
.. _Designate meetings wiki page: https://wiki.openstack.org/wiki/Meetings/Designate