9ad39c026c
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
24 lines
864 B
ReStructuredText
24 lines
864 B
ReStructuredText
.. _reportingissues:
|
|
|
|
Reporting Bugs
|
|
==============
|
|
|
|
Although every situation is different, this section describes how to
|
|
collect data which will help make efficient use of everyone's time
|
|
when dealing with vpp bugs.
|
|
|
|
Before you press the Jira button to create a bug report - or email
|
|
vpp-dev@lists.fd.io - please ask yourself whether there's enough
|
|
information for someone else to understand and to reproduce the issue
|
|
given a reasonable amount of effort. **Unicast emails to maintainers,
|
|
committers, and the project PTL are strongly discouraged.**
|
|
|
|
A good strategy for clear-cut bugs: file a detailed Jira ticket, and
|
|
then send a short description of the issue to vpp-dev@lists.fd.io,
|
|
perhaps from the Jira ticket description. It's fine to send email to
|
|
vpp-dev@lists.fd.io to ask a few questions **before** filing Jira tickets.
|
|
|
|
.. toctree::
|
|
|
|
reportingissues
|