summaryrefslogtreecommitdiffstats
path: root/DOCUMENTATION.md
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-01-17 11:19:11 -0700
committerChris Akritidis <43294513+cakrit@users.noreply.github.com>2020-01-17 10:19:11 -0800
commit7e90b89786b5118c72518acf73ab86595613b32f (patch)
tree7cdab4faa5e047eac10e7f68b72542a4a53b8cad /DOCUMENTATION.md
parenta48ab2124f9bc4f74d60e49586a655286be6ad70 (diff)
Improve styling of documentation site and use Algolia search (#7753)
* Improve styling and add Netdata logo * More CSS fixes, add Algolia search * Remove -v from cp to make output less messy * Cleanup and making more CSS improvements * Tweaks and fixed badges * Links and sidebar widths * Better search result styling * Additional CSS tweaks * Responsiveness improvements * Converting back to flexbox, a few other tweaks * Finish comment
Diffstat (limited to 'DOCUMENTATION.md')
-rw-r--r--DOCUMENTATION.md119
1 files changed, 58 insertions, 61 deletions
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index dd5cf76254..69b14271bf 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -11,77 +11,74 @@ questions about Netdata, such as how to install it, getting started guides, basi
Or, explore all of Netdata's documentation using the table of contents to your left.
<div class="homepage-nav">
-
- <div class="nav-page">
- <a href="packaging/installer/">
- <div class="button-header">
- <h3>Installation guide</h3>
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
- </div>
- <div class="button-text">
- <p>Use our automated one-line installation script to install Netdata on Linux systems or find detailed instructions for binary packages, Kubernetes, Docker, macOS, and more.</p>
- </div>
- </a>
- </div>
- <div class="nav-page">
- <a href="docs/step-by-step/step-00/">
- <div class="button-header">
- <h3>Step-by-step tutorial</h3>
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
- </div>
- <div class="button-text">
- <p>Take a guided tour through each of Netdata's core features—perfect for beginners. Follow detailed instructions to monitor your systems and apps, and start your journey into performance troubleshooting.</p>
- </div>
- </a>
- </div>
- <div class="nav-page">
- <a href="docs/getting-started/">
- <div class="button-header">
- <h3>Getting started guide</h3>
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
- </div>
- <div class="button-text">
- <p>Have some monitoring and system administration experience? Dive right into configuring Netdata, accessing the dashboard, working with the daemon, and changing how Netdata stores metrics.</p>
- </div>
- </a>
- </div>
- <div class="nav-page">
- <a href="docs/configuration-guide/">
- <div class="button-header">
- <h3>Configuration guide</h3>
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
- </div>
- <div class="button-text">
- <p>Take your configuration options from the <em>getting started guide</em> to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.</p>
- </div>
- </a>
- </div>
-
+ <a class="nav-page" href="packaging/installer/">
+ <div class="button-header">
+ <h3>Installation guide</h3>
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
+ </div>
+ <div class="button-text">
+ <p>Use our automated one-line installation script to install Netdata on Linux systems or find detailed instructions for binary packages, Kubernetes, Docker, macOS, and more.</p>
+ </div>
+ </a>
+ <a class="nav-page" href="docs/step-by-step/step-00/">
+ <div class="button-header">
+ <h3>Step-by-step tutorial</h3>
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
+ </div>
+ <div class="button-text">
+ <p>Take a guided tour through each of Netdata's core features—perfect for beginners. Follow detailed instructions to monitor your systems and apps, and start your journey into performance troubleshooting.</p>
+ </div>
+ </a>
+ <a class="nav-page" href="docs/getting-started/">
+ <div class="button-header">
+ <h3>Getting started guide</h3>
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
+ </div>
+ <div class="button-text">
+ <p>Have some monitoring and system administration experience? Dive right into configuring Netdata, accessing the dashboard, working with the daemon, and changing how Netdata stores metrics.</p>
+ </div>
+ </a>
+ <a class="nav-page" href="docs/configuration-guide/">
+ <div class="button-header">
+ <h3>Configuration guide</h3>
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
+ </div>
+ <div class="button-text">
+ <p>Take your configuration options from the <em>getting started guide</em> to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.</p>
+ </div>
+ </a>
</div>
-**Netdata Cloud**: Use [Netdata Cloud](docs/netdata-cloud/) and the [Nodes View](docs/netdata-cloud/nodes-view.md) to view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place. Add as many nodes as you'd like!
+**Netdata Cloud**: Use [Netdata Cloud](docs/netdata-cloud/) and the [Nodes View](docs/netdata-cloud/nodes-view.md) to
+view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place.
+Add as many nodes as you'd like!
-**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.
+**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.
+- [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 guide](CONTRIBUTING.md), [contributing to documentation guide](docs/contributing/contributing-documentation.md), and [documentation style guide](docs/contributing/style-guide.md) to learn more about our community and how you can get started contributing to Netdata.
+Visit the [contributing guide](CONTRIBUTING.md), [contributing to documentation
+guide](docs/contributing/contributing-documentation.md), and [documentation style
+guide](docs/contributing/style-guide.md) to learn more about our community and how you can get started contributing to
+Netdata.
-## Subscribe for news and tips from monitoring pros
+**Want to get news, how-tos, and heaps of monitoring savvy straight from Netdata? Subscribe to our newsletter to monitor
+our team of monitoring pros.**
<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/shell.js"></script>
-
<script>
hbspt.forms.create({
portalId: "4567453",
formId: "6a20deb5-a1e6-4312-9c4d-f6862f947fe0"
-});
+ });
</script>
-
----
-
-![A GIF of the standard Netdata dashboard](https://user-images.githubusercontent.com/2662304/48346998-96cf3180-e685-11e8-9f4e-059d23aa3aa5.gif)