Skip to content

Commit e25edb3

Browse files
committed
Link to Ironic dev-quickstart in contributing doc
Ironic dev-quickstart contains many relevant pieces of information for development against other Ironic projects, such as NGS. This information, like available tox environments and how to setup Ironic devstack, is valid for some NGS development cases as well. Change-Id: I660462d005d8f85bb880cf892cd0fbb33402ecab
1 parent 0aed9fd commit e25edb3

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

CONTRIBUTING.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,15 @@ Creating new device plugins
6464
The only required option is ``device_type`` that must be equal to the
6565
entrypoint you have registered your plugin under, as it is used for plugin
6666
lookup (see provided ``Netmiko``-based plugins for example).
67+
68+
69+
Additional Contributor Resources
70+
================================
71+
GenericSwitch is a member of the Bare Metal (ironic) program in OpenStack.
72+
Development of GenericSwitch follows many ironic conventions.
73+
74+
The `Ironic developer quickstart <https://docs.openstack.org/ironic/latest/contributor/dev-quickstart.html>_`
75+
has some relevant information -- particularly on unit testing with tox,
76+
integration testing with devstack, and other information that may be useful
77+
for GenericSwitch developers. As the documentation is written targetting
78+
Ironic, it should only be used as a general guideline.

0 commit comments

Comments
 (0)