diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
new file mode 100644
index 0000000000..df18a6d4ec
--- /dev/null
+++ b/DOCUMENTATION.md
@@ -0,0 +1,53 @@
+# Netdata Documentation
+
+**Netdata is real-time health monitoring and performance troubleshooting for systems and applications.** It helps you instantly diagnose slowdowns and anomalies in your infrastructure with thousands of metrics, interactive visualizations, and insightful health alarms.
+
+
+## Navigating the Netdata documentation
+
+Welcome! You've arrived at the documentation for Netdata. Use the links below to find answers to the most common questions about Netdata, such as how to install it, getting started guides, basic configuration, and adding more charts. Or, explore all of Netdata's documentation using the table of contents to your left.
+
+
+
+
+
One-line installation
+
Use our completely automated one-line installation process to get Netdata on all Linux distributions. Or, find detailed instructions for binary packages, Kubernetes, macOS, and more.
+
+
+
+
Getting started guide
+
The perfect place for Netdata beginners to start. Learn how to access Netdata's dashboard, start and stop the service, basic configuration, and more.
+
+
+
+
Configuration guide
+
Take your configuration options from the getting started guide to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.
+
+
+
+
+**Advanced users**: For those who already understand how to access a Netdata dashboard and perform basic configuration, feel free to see what's behind any of these other doors.
+
+ - [Netdata Behind Nginx](docs/Running-behind-nginx.md): Use an Nginx web server instead of Netdata's built-in server to enable TLS, HTTPS, and basic authentication.
+ - [Add More Charts](docs/Add-more-charts-to-netdata.md): Enable new internal or external plugins and understand when auto-detection works.
+ - [Performance](docs/Performance.md): Tips on running Netdata on devices with limited CPU and RAM resources, such as embedded devices, IoT, and edge devices.
+ - [Streaming](streaming/): Information for those who want to centralize Netdata metrics from any number of distributed agents.
+ - [Backends](backends/): Learn how to archive Netdata's real-time metrics to a time series database (like Prometheus) for long-term archiving.
+
+
+Visit the [contributing](CONTRIBUTING.md) page to find guides about the Netdata code of conduct, our community, and how you can get started contributing to Netdata.
+
+
+## Subscribe for news and tips from monitoring pros
+
+
+
+
+---
+
+![A GIF of the standard Netdata dashboard](https://user-images.githubusercontent.com/2662304/48346998-96cf3180-e685-11e8-9f4e-059d23aa3aa5.gif)
\ No newline at end of file
diff --git a/docs/generator/buildhtml.sh b/docs/generator/buildhtml.sh
index 424c58b8a6..885299b81c 100755
--- a/docs/generator/buildhtml.sh
+++ b/docs/generator/buildhtml.sh
@@ -24,13 +24,17 @@ echo "Copying files"
rm -rf ${SRC_DIR}
find . -type d \( -path ./${GENERATOR_DIR} -o -path ./node_modules \) -prune -o -name "*.md" -print | cpio -pd ${SRC_DIR}
+# Move main README.md file to what-is-netdata.md
+# echo "Replacing docs homepage"
+# mv ./${SRC_DIR}/README.md ./${SRC_DIR}/what-is-netdata.md
+# mv ./${SRC_DIR}/DOCUMENTATION.md ./${SRC_DIR}/README.md
+
# Copy Netdata html resources
cp -a ./${GENERATOR_DIR}/custom ./${SRC_DIR}/
-
# Modify the first line of the main README.md, to enable proper static html generation
echo "Modifying README header"
-sed -i -e '0,/# Netdata /s//# Introduction\n\n/' ${SRC_DIR}/README.md
+sed -i -e '0,/# Netdata /s//# Netdata Documentation\n\n/' ${SRC_DIR}/README.md
# Remove all GA tracking code
find ${SRC_DIR} -name "*.md" -print0 | xargs -0 sed -i -e 's/\[!\[analytics.*UA-64295674-3)\]()//g'
@@ -84,6 +88,10 @@ prep_html() {
if [ "${lang}" != "en" ] ; then
find "${GENERATOR_DIR}/${SITE_DIR}" -name "*.html" -print0 | xargs -0 sed -i -e 's/https:\/\/github.com\/netdata\/netdata\/blob\/master\/\S*md/https:\/\/github.com\/netdata\/localization\//g'
fi
+
+ # Replace index.html with DOCUMENTATION/index.html
+ echo "Replacing index.html with DOCUMENTATION/index.html"
+ cat ${GENERATOR_DIR}/${SITE_DIR}/DOCUMENTATION/index.html > ${GENERATOR_DIR}/${SITE_DIR}/index.html
}
for d in "en" $(find ${LOC_DIR} -mindepth 1 -maxdepth 1 -name .git -prune -o -type d -printf '%f ') ; do
diff --git a/docs/generator/buildyaml.sh b/docs/generator/buildyaml.sh
index e4f9c8454c..ed0724d351 100755
--- a/docs/generator/buildyaml.sh
+++ b/docs/generator/buildyaml.sh
@@ -53,7 +53,7 @@ repo_url: https://github.com/netdata/netdata
repo_name: GitHub
edit_uri: blob/master
site_description: Netdata Documentation
-copyright: Netdata, 2018
+copyright: Netdata, 2019
docs_dir: '${docs_dir}'
site_dir: '${site_dir}'
#use_directory_urls: false
@@ -123,9 +123,12 @@ markdown_extensions:
- pymdownx.extrarawhtml
nav:'
-navpart 1 . README "About"
+navpart 1 . "README" ""
-echo -ne " - 'docs/Demo-Sites.md'
+navpart 1 . . "About Netdata"
+
+echo -ne " - 'docs/what-is-netdata.md'
+ - 'docs/Demo-Sites.md'
- 'docs/netdata-security.md'
- 'docs/anonymous-statistics.md'
- 'docs/Donations-netdata-has-received.md'
diff --git a/docs/generator/custom/css/netdata.css b/docs/generator/custom/css/netdata.css
index 116eb15d97..437c4ad175 100644
--- a/docs/generator/custom/css/netdata.css
+++ b/docs/generator/custom/css/netdata.css
@@ -6,6 +6,36 @@
font-size: .75rem
}
+/* Custom styling for the new documentation homepage.
+ In particular, the three buttons for install/getting started/configuration. */
+
+.homepage-nav {
+ display: flex;
+ margin-top: 1.4rem;
+}
+
+.homepage-nav div {
+ flex: 1;
+}
+
+.homepage-nav .nav-install {
+ margin-right: 1rem;
+}
+
+.homepage-nav .nav-configuration {
+ margin-left: 1rem;
+}
+
+.nav-button {
+ border: 2px solid black;
+ border-radius: 4px;
+ display: block;
+ font-weight: 700;
+ margin: 0 auto;
+ padding: 0.6rem 0;
+ text-align: center;
+}
+
/* Hide the label at the top of the navigation menu. Does nothing. */
.md-nav__title {
display: none;
diff --git a/docs/what-is-netdata.md b/docs/what-is-netdata.md
new file mode 100644
index 0000000000..6664897dee
--- /dev/null
+++ b/docs/what-is-netdata.md
@@ -0,0 +1,385 @@
+# What is Netdata?
+
+[![Build Status](https://travis-ci.com/netdata/netdata.svg?branch=master)](https://travis-ci.com/netdata/netdata) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2231/badge)](https://bestpractices.coreinfrastructure.org/projects/2231) [![License: GPL v3+](https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Freadme&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+
+[![Code Climate](https://codeclimate.com/github/netdata/netdata/badges/gpa.svg)](https://codeclimate.com/github/netdata/netdata) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a994873f30d045b9b4b83606c3eb3498)](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) [![LGTM C](https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:cpp) [![LGTM JS](https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:javascript) [![LGTM PYTHON](https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:python)
+
+---
+
+**Netdata** is **distributed, real-time, performance and health monitoring for systems and applications**. It is a highly optimized monitoring agent you install on all your systems and containers.
+
+Netdata provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including web servers, databases, applications), using **highly interactive web dashboards**. It can run autonomously, without any third party components, or it can be integrated to existing monitoring tool chains (Prometheus, Graphite, OpenTSDB, Kafka, Grafana, etc).
+
+_Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting their core function._
+
+Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **MacOS**.
+
+---
+
+## How it looks
+
+The following animated image, shows the top part of a typical Netdata dashboard.
+
+![peek 2018-11-11 02-40](https://user-images.githubusercontent.com/2662304/48307727-9175c800-e55b-11e8-92d8-a581d60a4889.gif)
+
+*A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive and **real-time**, optimized to get the work done!*
+
+> *We have a few online demos to experience it live: [https://www.netdata.cloud](https://www.netdata.cloud/#live-demo)*
+
+## User base
+
+Netdata is used by hundreds of thousands of users all over the world.
+Check our [GitHub watchers list](https://github.com/netdata/netdata/watchers).
+You will find people working for **Amazon**, **Atos**, **Baidu**, **Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**,
+**Elastic**, **EPAM Systems**, **Ericsson**, **Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**,
+**IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red Hat**, **SAP**, **Selectel**, **TicketMaster**,
+**Vimeo**, and many more!
+
+### Docker pulls
+We provide docker images for the most common architectures. These are statistics reported by docker hub:
+
+[![netdata/netdata (official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/) [![firehol/netdata (deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/) [![titpetric/netdata (donated)](https://img.shields.io/docker/pulls/titpetric/netdata.svg?label=titpetric/netdata+%28third+party%29)](https://hub.docker.com/r/titpetric/netdata/)
+
+### Registry
+When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/#registry). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
+
+[![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2÷=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k÷=1000&value_color=orange&precision=2&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2÷=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
+
+*in the last 24 hours:*