diff --git a/doc/Developing/Creating-Documentation.md b/doc/Developing/Creating-Documentation.md new file mode 100644 index 0000000000..00029297c3 --- /dev/null +++ b/doc/Developing/Creating-Documentation.md @@ -0,0 +1,19 @@ +# Creating Documentation + +One of the goals of the LibreNMS project is to enable users to get all of the help they need from our documentation. + +When you are adding a new feature or extension, we need to have full documentation to go along with it. It's quite +simple to do this: + + - Find the relevant directory to store your new document in, General, Support and Extensions are the most likely choices. + - Think of a descriptive name that's not too long, it should match what they may be looking for or describes the feature. + - In the body of the document, be descriptive but keep things simple. Some tips: + - If the document could cover different distros like CentOS and Ubuntu please try and include the information for them all. + If that's not possible then at least put a placeholder in asking for contributions. + - Ensure you use the correct formating for `commands` and `code blocks` by wrapping one liners in backticks or blocks in ```. + - If you rename a file, please add a redirect in for the old file by using `` within the old file name. + +Please ensure you add the document to the relevant section within `pages` of `mkdocs.yml` so that it's in the correct menu and is built. +Forgetting this step will result in your document never seeing the light of day :) + + diff --git a/doc/Installation/Installation-CentOS-7-Apache.md b/doc/Installation/Installation-CentOS-7-Apache.md index 343ed839d6..30e7391242 100644 --- a/doc/Installation/Installation-CentOS-7-Apache.md +++ b/doc/Installation/Installation-CentOS-7-Apache.md @@ -41,7 +41,7 @@ yum install epel-release rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm rpm -Uvh https://mirror.webtatic.com/yum/el7/webtatic-release.rpm -yum install php70w php70w-cli php70w-gd php70w-mysql php70w-snmp php70w-pear php70w-curl php70w-common php70w-fpm nginx net-snmp mariadb ImageMagick jwhois nmap mtr rrdtool MySQL-python net-snmp-utils cronie php70w-mcrypt fping git +yum install php70w php70w-cli php70w-gd php70w-mysql php70w-snmp php70w-pear php70w-curl php70w-common httpd net-snmp mariadb ImageMagick jwhois nmap mtr rrdtool MySQL-python net-snmp-utils cronie php70w-mcrypt fping git pear install Net_IPv4-1.3.4 pear install Net_IPv6-1.2.2b2 diff --git a/mkdocs.yml b/mkdocs.yml index 3aefb47bc1..948b1fe3ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,6 +71,7 @@ pages: - Developing: - Developing/Code-Guidelines.md - Developing/Code-Structure.md + - Developing/Creating-Documentation.md - Developing/Dynamic-Config.md - Developing/Sensor-State-Support.md - Developing/Style-Guidelines.md