Docs: Add Installation Guides to the Sphinx Documentation
As part of the initial conversion of the user guide to Sphinx documentation (see: https://redmine.openinfosecfoundation.org/issues/1612) the installation guides have been left out.
We should add some installation guides that aren't expected to change much during the life of the release. These could be:
- Generic ./configure installation instructions.
- CentOS installation instructions.
- Ubuntu LTS installation instructions.
Other installation instructions that is likely to need updating during the life of a release for reasons beyond our control should be kept on the wiki.
Updated by Jason Ish over 5 years ago
I'd say improving or fixing bad install docs on wiki should take priority over getting install docs into the new user manual.
This is something that should probably be reviewed for 3.0.. At least break it into sections - known working, and old docs that may or may not work for you perhaps?
Updated by Stian Bergseth almost 3 years ago
Isnt this already resolved? https://suricata.readthedocs.io/en/latest/install.html
Updated by Jason Ish almost 3 years ago
- Status changed from New to Closed
Marking as closed.
I think we discussed in various formats having basic installation documentation in the Sphinx docs, but also keeping it on the Wiki as we can update the Wiki without pushing code should we need to update the install docs for a specific distribution. That appears to what we have now. The Sphinx docs even links to the Wiki docs for advanced/other operating systems.