Merge pull request #2189 from qlyoung/move-bug-reports-to-docs

doc: move REPORTING-BUGS to user docs

COMMUNITY.md

@@ -1 +0,0 @@
-Moved to doc/developer/workflow.rst

Makefile.am

@@ -83,7 +83,6 @@ rc_SCRIPTS = \
 endif
 
 EXTRA_DIST += \
-	REPORTING-BUGS \
 	SERVICES \
 	aclocal.m4 \
 	update-autotools \

README

@@ -5,9 +5,9 @@ Currently FRRouting supports BGP4, BGP4+, OSPFv2, OSPFv3, RIPv1, RIPv2, RIPng,
 IS-IS, PIM-SM/MSDP, LDP and Babel as well as very early support for EIGRP and
 NHRP.
 
-See the file REPORTING-BUGS to report bugs.
+See doc/user/bugs.rst for information on how to report bugs.
 
-See COMMUNITY.md for information on contributing.
+See doc/developer/workflow.rst for information on contributing.
 
 Free RRRouting is free software. See the file COPYING for copying conditions.
 

REPORTING-BUGS

@@ -1,35 +0,0 @@
-This file describes the procedure for reporting FRRouting bugs. You are not
-obliged to follow this format, but it would be great help for FRRouting developers
-if you report a bug as described below.
-
-Bugs submitted with woefully incomplete information may be summarily
-closed.  Submitters of bugs against old versions may be asked to
-retest against the latest release.  Submitters may be asked for
-additional information.  Bugs may be closed after 30 days of
-non-response to requests to reconfirm or supply additional
-information.
-
-Report bugs on Github Issue Tracker at 
-    https://github.com/frrouting/frr/issues
-
-Please supply the following information:
-1. Your FRRouting version or if it is from git then the  commit reference.
-   Please try to report bugs against git master or the latest release.
-2. FRR daemons you run e.g. bgpd or ripd and full name of your OS. Any
-   specific options you compiled FRR with. 
-3. Problem description. Copy and paste relative commands and their output to
-   describe your network setup e.g. "zebra>show ip route".
-   Please, also give your simple network layout and output of relative OS
-   commands (e.g., ifconfig (BSD) or ip (Linux)).
-4. All FRR configuration files you use. If you don't want to publish your
-   network numbers change 2 middle bytes in IPv4 address to be XXX (e.g.
-   192.XXX.XXX.32/24). Similar could be done with IPv6.
-5. If any FRR daemon core dumped, please, supply stack trace using the
-   following commands: host> gdb exec_file core_file , (gdb) bt .
-6. Run all FRR daemons with full debugging on (see documentation on
-   debugging) and send _only_ part of logs which are relative to your problem.
-7. If the problem is difficult to reproduce please send a shell script to
-   reproduce it.
-8. Patches, workarounds, fixes are always welcome.
-
-Thank You.

debianpkg/frr-doc.docs

@@ -1,6 +1,5 @@
 AUTHORS
 NEWS
 README
-REPORTING-BUGS
 doc/user/*.rst
 doc/figures/*.png

doc/user/bugs.rst

@@ -0,0 +1,67 @@
+.. _bugs:
+
+**************
+Reporting Bugs
+**************
+
+This file describes the procedure for reporting FRRouting bugs.  You are asked
+to follow this format when submitting bug reports.
+
+Bugs submitted with woefully incomplete information will receive little
+attention and are likely to be closed. If you hit a suspected bug in an older
+version, you may be asked to test with a later version in your environment.
+
+Often you may be asked for additional information to help solve the bug. Bugs
+may be closed after 30 days of non-response to requests to reconfirm or supply
+additional information.
+
+Please report bugs on the project GitHub issue tracker at
+https://github.com/frrouting/frr/issues
+
+Report Format & Requested Information
+=====================================
+
+When reporting a bug, please provide the following information.
+
+#. Your FRR version if it is a release build, or the commit hash if you built
+   from source.
+
+#. If you compiled from source, please provide your ``./configure`` line,
+   including all option flags.
+
+#. A full list of the FRR daemons you run.
+
+#. Your platform name and version, e.g. ``Ubuntu 18.04``.
+
+#. Problem description.
+
+   - Provide as much information as possible.
+   - Copy and paste relevant commands and their output to describe your network
+     setup.
+   - Topology diagrams are helpful when reporting bugs involving more than one
+     box.
+   - Platform routing tables and interface configurations are useful if you are
+     reporting a routing issue.
+
+   *Please be sure to review the provided information and censor any sensitive
+   material.*
+
+#. All FRR configuration files you use. Again, please be sure to censor any
+   sensitive information. For sensitive v4 / v6 addresses, we ask that you
+   censor the inner octets; e.g., ``192.XXX.XXX.32/24``.
+
+#. If you are reporting a crash and have a core file, please supply a stack
+   trace using GDB:
+
+   ::
+
+      $ gdb exec_file core_file
+        (gdb) bt .
+
+#. Run all FRR daemons with full debugging on and send *only* the portion of
+   logs which are relevant to your problem.
+
+#. Patches, workarounds, and fixes are always welcome.
+
+.. seealso:: :ref:`basic-config-commands`
+

doc/user/index.rst

@@ -27,6 +27,7 @@ FRRouting User Guide
    ripngd
    sharp
    vnc
+   bugs
    glossary
    appendix
 

redhat/frr.spec.in

@@ -534,7 +534,7 @@ rm -rf %{buildroot}
 %defattr(-,root,root)
 %doc */*.sample* AUTHORS COPYING
 %doc doc/mpls
-%doc ChangeLog INSTALL NEWS README REPORTING-BUGS SERVICES
+%doc ChangeLog NEWS README SERVICES
 %if 0%{?frr_user:1}
 %dir %attr(751,%frr_user,%frr_user) %{_sysconfdir}
 %dir %attr(750,%frr_user,%frr_user) /var/log/frr