Feature #1658
closed
Docs: Add Installation Guides to the Sphinx Documentation
Added by Jason Ish almost 9 years ago.
Updated about 6 years ago.
Description
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.
Since we have a small mess with some really outdated or "bad" installations i would also suggest to improve those section completely when we divide it into general instructions and specific installatin.
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?
I agree with Jason here.
It would not be that tough to go over the install docs and confirm/fix those.
Same for specific Debian releases like Jessie.
- 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.
Also available in: Atom
PDF