new netdata documentation - help needed #1518

Open
ktsaou opened this Issue Jan 6, 2017 · 4 comments

Projects

None yet

4 participants

@ktsaou
Member
ktsaou commented Jan 6, 2017 edited

Yes, I know: documentation is a mess.

Well, I think there should be documentation in the following structure.

One way to do it, is to open a new github repo to put all documentation there and then replace the wiki of this repo with the new one. For this to work, this has to be quick (otherwise the 2 wikis will get out of sync pretty quickly).

If you are willing to help me out, please join.


netdata documentation

  1. Introduction
    • What it is
    • How it works
    • Quick Start Guide

  1. Install netdata
    • General installation instructions for any system
    • Install on Debian/Ubuntu Linux
    • Install on Centos/Fedora/Redhat Enterprise Linux
    • Install on Arch Linux
    • Install on Gentoo Linux
    • Install on Alpine Linux
    • Install on Raspberry Pi
    • Install on FreeBSD
    • Install on MacOS
    • Install on Amazon Machine Image (AMI)
    • Install on Ubuntu on Windows 10
    • Install in a container
      • Install in docker containers
      • Install in LXC containers
    • Updating netdata to latest version

  1. Configuring netdata
    • netdata Configuration Guide
    • Tuning CPU consumption (for weak IoT devices)
    • Tuning Memory usage
    • Tuning for high performance (public netdata on the internet)

  1. Running netdata
    • Command Line Options Reference
    • Log Files
    • Tracing Options

  1. Data Collection
    • Monitor Processes, Users & User Groups
    • Monitor Disks
    • Monitor Containers
      • Monitor docker containers
      • Monitor lxc/lxd containers
      • Monitor ephemeral containers
    • Monitor Network Latency (fping)
    • Monitor SNMP Devices
    • Monitor Hardware Sensors
    • Monitor apache Web Servers
    • Monitor nginx Web Servers
    • Monitor tomcat Web Servers
    • Monitor PHP-FPM Applications
    • Monitor mysql/mariadb Databases
    • Monitor postgres Databases
    • Monitor redis Databases
    • Monitor memcached Databases
    • Monitor ISC bind Name Servers
    • Monitor Squid Proxy Servers
    • Monitor OpenSIPs Servers
    • Monitor Mail Servers (postfix, exit, dovecot)
    • Monitor Access Points (hostapd)
    • Monitor UPS (nut, apc)
    • Monitor Fail2Ban Servers
    • Monitor ISC dhcpd Servers
    • Monitor RetroShare (social sharing)
    • Monitor FreeRadius (AAA)
    • Monitor OpenVPN

  1. my-netdata Menu - netdata Registry
    • How it works
    • Run your own registry

  1. Data Archiving - Backends
    • Introduction - How it works
    • graphite backend
    • opentsdb backend
    • prometheus backend
    • viewing archived data with Grafana

  1. Health Monitoring - Alarms
    • Introduction - How it works
    • Health Monitoring Configuration Guide
      • Health Configuration Files
      • Writing New Alarms
    • Alarm Notifications
      • email notifications
      • pagerduty notifications
      • pushbullet notifications
      • pushover notifications
      • slack.com notifications
      • telegram notifications
      • twilio notifications
    • Troubleshooting Alarms

  1. Security Considerations
    • Securing netdata
      • User authentication via nginx
      • User authentication via apache
      • User authentication via lighttpd
      • User authentication via caddy

  1. How to write a Data Collection plugin
    • Understanding Charts and Metrics
    • Data Collection API Reference
    • Internal Plugins API (C)
    • External Plugins API (any language)
    • charts.d.plugin API (bash)
    • node.d.plugin API (node.js)
    • python.d.plugin API (python)

  1. Dashboard Web API
    • Overview
    • Web API Reference
    • Creating Custom Dashboards
    • Generating Badges
@diizzyy
diizzyy commented Jan 7, 2017

FreeBSD will more than likely have netdata in ports (package repo) once there's a release.
It's also listed in Wanted Ports. https://wiki.freebsd.org/WantedPorts

@simonnagl
Contributor

This replaces #378.

The table of contents you posted above looks good. Some thoughts of the old thread:

  1. Netdata should get a manage describing the absolute minimum needed. (Mostly where to get further information)
  2. For new contributors the header files should be documented much better. I suggest using doxygen. If you like I can focus on the doxygen documentation but I will need your help there.
@simonnagl simonnagl referenced this issue Jan 11, 2017
Closed

Documentation #378

1 of 24 tasks complete
@glensc
Contributor
glensc commented Jan 11, 2017

@ktsaou just reminder, if deciding to create new repo, wiki has git url so you can clone to keep the history from wiki's git:

git clone https://github.com/firehol/netdata.wiki.git
git remote add newrepo https://github.com/firehol/docs.git

actually same applies if deciding to merge with netdata repo, just need to use --allow-unrelated-histories option to git merge, and perhaps even git filter-branch to mv to subdir files

@ktsaou
Member
ktsaou commented Jan 11, 2017

thanks! I am already keeping a backup of the wiki every few minutes and I am receiving alarms when pages are edited (better be safe than sorry...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment