Split a community page out of the contributor docs
We need a simple "how to reach out to us" page that is not mixed with code contribution guide. This change adds it by moving information around and polishing it a bit. Change-Id: I0a458c3baddaaa2226cd2105d6325025a0c81f05
This commit is contained in:
Dmitry Tantsur
parent
ef5c283d46
commit
2c3470353d
@ -24,7 +24,9 @@ Reporting Guide
|
||||
We are constantly receiving a lot of requests, so it's important to file a
|
||||
meaningful story for it to be acted upon. A good story:
|
||||
|
||||
* specifies **why** a change is needed.
|
||||
* specifies **why** a change is needed. In case of a bug - what you expected
|
||||
to happen.
|
||||
|
||||
* explains how to reproduce the described condition.
|
||||
|
||||
.. note::
|
||||
@ -35,7 +37,12 @@ meaningful story for it to be acted upon. A good story:
|
||||
a product, please try contacting support first.
|
||||
|
||||
* should be understandable without additional context. For example, if you see
|
||||
an exception, we will need the full traceback.
|
||||
an exception, we will need the full traceback. Other commonly required
|
||||
things are:
|
||||
|
||||
* the contents of the node in question (use ``baremetal node show <uuid>``)
|
||||
* debug logging related to the event, ideally with logs from the ramdisk
|
||||
* versions of ironic, ironic-python-agent, and any other coupled components.
|
||||
|
||||
* should not be too verbose either. Unfortunately, we cannot process a few days
|
||||
worth of system logs to find the problems, we expect your collaboration.
|
||||
|
||||
85
doc/source/contributor/community.rst
Normal file
85
doc/source/contributor/community.rst
Normal file
@ -0,0 +1,85 @@
|
||||
====================
|
||||
Bare Metal Community
|
||||
====================
|
||||
|
||||
This document provides information on how to reach out to the community for
|
||||
questions, bug reports or new code contributions.
|
||||
|
||||
Useful Links
|
||||
============
|
||||
|
||||
Bug/Task tracker
|
||||
https://storyboard.openstack.org/#!/project/openstack/ironic
|
||||
|
||||
Code Hosting
|
||||
https://opendev.org/openstack/ironic
|
||||
|
||||
Code Review
|
||||
https://review.opendev.org/#/q/status:open+project:openstack/ironic,n,z
|
||||
|
||||
Weekly Meeting Agenda
|
||||
https://wiki.openstack.org/wiki/Meetings/Ironic#Agenda_for_next_meeting
|
||||
|
||||
Asking Questions
|
||||
================
|
||||
|
||||
There are two many venues where all discussions happen: IRC and mailing lists.
|
||||
|
||||
Internet Relay Chat 'IRC'
|
||||
-------------------------
|
||||
|
||||
Daily contributor discussions take place on IRC in the ``#openstack-ironic``
|
||||
channel on the OFTC IRC network. Please feel free to connect to
|
||||
``ircs://irc.oftc.net:6697`` and join our channel!
|
||||
|
||||
Note that while we have community members from everywhere in the world, we're
|
||||
the most active from roughly 6am to 12am. If you don't get an answer to your
|
||||
question, try the `Mailing list`_.
|
||||
|
||||
Additional information on getting connected can be found in the
|
||||
`OpenStack community contribution guide <https://docs.openstack.org/contributors/common/irc.html>`_.
|
||||
|
||||
Mailing list
|
||||
------------
|
||||
|
||||
We use the *openstack-discuss* mailing list for asynchronous communications and
|
||||
longer discussions. Navigate to
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
to subscribe or view the archives.
|
||||
|
||||
When sending a message please prefix the *Subject* line with ``[ironic]`` so
|
||||
that we don't miss it.
|
||||
|
||||
Reporting Bugs
|
||||
==============
|
||||
|
||||
LaunchPad
|
||||
---------
|
||||
|
||||
Most of the tools used for OpenStack require a Launchpad_ ID for
|
||||
authentication. Ironic previously used to track work on Launchpad,
|
||||
but we have not done so since migrating to Storyboard_.
|
||||
|
||||
.. _Launchpad: https://launchpad.net
|
||||
|
||||
Storyboard
|
||||
----------
|
||||
|
||||
The ironic project moved from Launchpad to `StoryBoard
|
||||
<https://storyboard.openstack.org/>`_ for work and task tracking.
|
||||
This provides an aggregate view called a "Project Group"
|
||||
and individual "Projects". A good starting place is the
|
||||
`project group <https://storyboard.openstack.org/#!/project_group/ironic>`_
|
||||
representing the whole of the ironic community, as opposed to
|
||||
the `ironic project <https://storyboard.openstack.org/#!/project/943>`_
|
||||
storyboard which represents ironic as a repository.
|
||||
|
||||
See :doc:`bugs` for more details on how we track bugs.
|
||||
|
||||
Contributing Code
|
||||
=================
|
||||
|
||||
.. seealso::
|
||||
|
||||
* :doc:`contributing` - basic information on new code contributions
|
||||
* :doc:`/contributor/index`
|
||||
@ -6,10 +6,11 @@ So You Want to Contribute...
|
||||
|
||||
This document provides some necessary points for developers to consider when
|
||||
writing and reviewing Ironic code. The checklist will help developers get
|
||||
things right.
|
||||
things right. Please make sure to check the :doc:`community page <community>`
|
||||
first.
|
||||
|
||||
Getting Started
|
||||
===============
|
||||
Contributing Code
|
||||
=================
|
||||
|
||||
If you're completely new to OpenStack and want to contribute to the ironic
|
||||
project, please start by familiarizing yourself with the `Infra Team's Developer
|
||||
@ -18,44 +19,8 @@ help you get your accounts set up in Launchpad and Gerrit, familiarize you with
|
||||
the workflow for the OpenStack continuous integration and testing systems, and
|
||||
help you with your first commit.
|
||||
|
||||
LaunchPad
|
||||
---------
|
||||
|
||||
Most of the tools used for OpenStack require a launchpad.net ID for
|
||||
authentication. Ironic previously used to track work on Launchpad,
|
||||
but we have not done so since migrating to Storyboard.
|
||||
|
||||
.. seealso::
|
||||
|
||||
* https://launchpad.net
|
||||
|
||||
Storyboard
|
||||
----------
|
||||
|
||||
The ironic project moved from Launchpad to `StoryBoard
|
||||
<https://storyboard.openstack.org/>`_ for work and task tracking.
|
||||
This provides an aggregate view called a "Project Group"
|
||||
and individual "Projects". A good starting place is the
|
||||
`project group <https://storyboard.openstack.org/#!/project_group/ironic>`_
|
||||
representing the whole of the ironic community, as opposed to
|
||||
the `ironic project <https://storyboard.openstack.org/#!/project/943>`_
|
||||
storyboard which represents ironic as a repository.
|
||||
|
||||
See :doc:`bugs` for more details on how we track bugs.
|
||||
|
||||
Internet Relay Chat 'IRC'
|
||||
-------------------------
|
||||
|
||||
Daily contributor discussions take place on IRC in the '#openstack-ironic'
|
||||
channel on the OFTC IRC network.
|
||||
|
||||
Please feel free to join us at ircs://irc.oftc.net:6697 and join our channel!
|
||||
|
||||
Additional information on getting connected can be found in the
|
||||
`OpenStack community contribution guide <https://docs.openstack.org/contributors/common/irc.html>`_.
|
||||
|
||||
Everything Ironic
|
||||
~~~~~~~~~~~~~~~~~
|
||||
-----------------
|
||||
|
||||
Ironic is a community of projects centered around the primary project
|
||||
repository 'ironic', which help facilitate the deployment and management
|
||||
@ -81,28 +46,6 @@ which are developed by the same community.
|
||||
* :python-ironicclient-doc:`Ironic Client Documentation <>`
|
||||
* :python-ironic-inspector-client-doc:`Ironic Inspector Client Documentation <>`
|
||||
|
||||
Useful Links
|
||||
------------
|
||||
|
||||
Bug/Task tracker
|
||||
https://storyboard.openstack.org/#!/project/943
|
||||
|
||||
Mailing list (prefix Subject line with ``[ironic]``)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
|
||||
Code Hosting
|
||||
https://opendev.org/openstack/ironic
|
||||
|
||||
Code Review
|
||||
https://review.opendev.org/#/q/status:open+project:openstack/ironic,n,z
|
||||
|
||||
Whiteboard
|
||||
https://etherpad.openstack.org/p/IronicWhiteBoard
|
||||
|
||||
Weekly Meeting Agenda
|
||||
https://wiki.openstack.org/wiki/Meetings/Ironic#Agenda_for_next_meeting
|
||||
|
||||
|
||||
Adding New Features
|
||||
===================
|
||||
|
||||
@ -365,24 +308,6 @@ For approved and completed specs:
|
||||
Please see the `Ironic specs process wiki page <https://wiki.openstack.org/
|
||||
wiki/Ironic/Specs_Process>`_ for further reference.
|
||||
|
||||
Bug Reporting
|
||||
=============
|
||||
|
||||
Bugs can reported via our Task and Bug tracking tool Storyboard.
|
||||
|
||||
When filing bugs, please include as much detail as possible, and don't be shy.
|
||||
|
||||
Essential pieces of information are generally:
|
||||
|
||||
* Contents of the 'node' - `baremetal node show <uuid>`
|
||||
* Steps to reproduce the issue.
|
||||
* Exceptions and surrounding lines from the logs.
|
||||
* Versions of ironic, ironic-python-agent, and any other coupled components.
|
||||
|
||||
Please also set your expectations of what *should* be happening.
|
||||
Statements of user expectations are how we understand what is occuring and
|
||||
how we learn new use cases!
|
||||
|
||||
Project Team Leader Duties
|
||||
==========================
|
||||
|
||||
|
||||
@ -11,6 +11,7 @@ project.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Bare Metal Community <community>
|
||||
Developer Contribution Guide <contributing>
|
||||
Bugs Reporting and Triaging Guide <bugs>
|
||||
Setting Up Your Development Environment <dev-quickstart>
|
||||
|
||||
@ -24,6 +24,8 @@ https://docs.openstack.org/ironic/ocata/.
|
||||
|
||||
Found a bug in one of our projects? Please see :doc:`/contributor/bugs`.
|
||||
|
||||
Would like to engage with the community? See :doc:`/contributor/community`.
|
||||
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user