summaryrefslogtreecommitdiffstats
path: root/docs/troubleshooting/reportingissues/reportingissues.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak1-284/+0
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>
2019-12-18docs: update troubleshooting commandsPaul Vinciguerra1-2/+2
Depends-On: https://gerrit.fd.io/r/c/vpp/+/22819 Type: docs Change-Id: I1e2170a524e19cb91836a8073f62100b88f46cee Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-12-17docs: improve compressed core file documentationDave Barach1-5/+15
In particular, document "zcat vpp_core.gz | dd conv=sparse of=vpp_core" Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I01b70492ced864b47847c2ef7bc1ea8eb0980ec3
2019-07-12docs: add compressed core file descriptionDave Barach1-0/+27
To the issue reporting page Change-Id: I3d2b53521bcb1b9b4a85802a84427f17390f0f77 Type: docs Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-12docs: how to enable coredump with systemdBenoît Ganne1-0/+4
Type: docs Change-Id: I1f657389fec716cc6cdc942803e65f861ffea5f5 Signed-off-by: Benoît Ganne <bganne@cisco.com>
2019-02-27DOC ONLY: update bug report sectionDave Barach1-31/+58
More detail on why it's important to supply .debs or .rpms which precisely match core files. Probably won't help, but we can try... Change-Id: I7842eaea0ef921b934e84b7f18f6a333b1381292 Signed-off-by: Dave Barach <dave@barachs.net>
2018-07-26Initial commit of Sphinx docsJohn DeNisco1-0/+216
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>