Просмотр исходного кода

Sanitize headers and htmlstructure (#4713)

* Restructured html site, corrected header in REDISTRIBUTED

* Added header

* Header updates and restructuring

* Move requirements and runtime txts to htmldoc, by adding a netlify.toml that changes the base directory

* Minor corrections to support the html doc restructuring

* Debugging netlify

* Debugging netlify

* Debugging netlify

* Beautify headers, comment in buildhtml

* Beautify headers

* Sanitize headers and reorganize static html site

* Updated Makefile with moved and created htmldoc scripts
Chris Akritidis 6 лет назад
Родитель
Сommit
1149ce3240

+ 4 - 2
Makefile.am

@@ -81,8 +81,7 @@ dist_noinst_DATA= \
 	installer/README.md \
 	installer/UNINSTALL.md \
 	installer/UPDATE.md \
-	requirements.txt \
-	runtime.txt \
+	netlify.toml \
 	$(NULL)
 
 # until integrated within build
@@ -95,6 +94,9 @@ dist_noinst_SCRIPTS= \
 	installer/functions.sh \
 	htmldoc/buildhtml.sh \
 	htmldoc/buildyaml.sh \
+	htmldoc/checklinks.sh \
+	htmldoc/requirements.txt \
+	htmldoc/runtime.txt \
 	$(NULL)
 
 # -----------------------------------------------------------------------------

+ 6 - 6
README.md

@@ -69,7 +69,7 @@ We provide docker images for the most common architectures. These are statistics
 [![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/#netdata-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:
+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&divide=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&divide=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&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)  
   
@@ -180,11 +180,11 @@ This is how it works:
 Function|Description|Documentation
 :---:|:---|:---:
 **Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](collectors/#data-collection-plugins)
-**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](database/#netdata-database)
+**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](database/#database)
 **Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](health/#health-monitoring)
-**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote netdata servers, as soon as they are collected.|[`streaming`](streaming/#metrics-streaming)
+**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote netdata servers, as soon as they are collected.|[`streaming`](streaming/#streaming-and-replication)
 **Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](backends/)
-**Query**|Multiple independent workers are attached to the [internal web server](web/server/#netdata-web-server), servicing API requests, including [data queries](web/api/queries/#database-queries).|[`web/api`](web/api/#api)
+**Query**|Multiple independent workers are attached to the [internal web server](web/server/#web-server), servicing API requests, including [data queries](web/api/queries/#database-queries).|[`web/api`](web/api/#api)
 
 The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric.
 
@@ -253,7 +253,7 @@ Charts on netdata dashboards are synchronized to each other. There is no master
 
 *Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the mouse pointer is over a chart.*
 
-> The visible time-frame (pan and zoom) is propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#netdata-registry).
+> The visible time-frame (pan and zoom) is propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#registry).
 
 
 ### Highlighted time-frame
@@ -264,7 +264,7 @@ To improve visual anomaly detection across charts, the user can highlight a time
 
 *A highlighted time-frame can be given by pressing `ALT` + `mouse selection` on any chart. Netdata will highlight the same range on all charts.*
 
-> Highlighted ranges are propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#netdata-registry).
+> Highlighted ranges are propagated from netdata server to netdata server, when navigating via the [`my-netdata` menu](registry#registry).
 
 
 ## What does it monitor  

+ 8 - 11
REDISTRIBUTED.md

@@ -1,18 +1,15 @@
-# Netdata
+# Redistributed software
 
-Copyright 2016-2017, Costa Tsaousis.
-Copyright 2017-2018, Netdata Inc.
-Released under [GPL v3 or later](http://www.gnu.org/licenses/gpl-3.0.en.html).
+netdata copyright info:
+ Copyright 2016-2018, Costa Tsaousis.
+ Copyright 2018, Netdata Inc.
+ Released under [GPL v3 or later](LICENSE).
 
-Netdata uses SPDX license tags to identify the license for its files.
+netdata uses SPDX license tags to identify the license for its files.
 Individual licenses referenced in the tags are available on the [SPDX project site](http://spdx.org/licenses/).
 
----
-
-## Re-distributed software
-
-Netdata re-distributes the following third-party software.
-We have decided to re-distribute all these, instead of using them
+netdata redistributes the following third-party software.
+We have decided to redistribute all these, instead of using them
 through a CDN, to allow netdata to work in cases where Internet
 connectivity is not available.
 

+ 1 - 1
backends/README.md

@@ -1,4 +1,4 @@
-# Metrics Long Term Archiving
+# Metrics long term archiving
 
 netdata supports backends for archiving the metrics, or providing long term dashboards,
 using Grafana or other tools, like this:

+ 1 - 1
collectors/README.md

@@ -1,4 +1,4 @@
-# Data Collection Plugins
+# Data collection plugins
 
 netdata supports **internal** and **external** data collection plugins:
 

+ 5 - 0
collectors/charts.d.plugin/apcupsd/README.md

@@ -0,0 +1,5 @@
+# apcupsd
+
+*Under construction*
+
+Collects UPS metrics

+ 2 - 0
collectors/charts.d.plugin/example/README.md

@@ -1,2 +1,4 @@
+# Example
+
 This is just an example charts.d data collector.
 

+ 5 - 0
collectors/charts.d.plugin/opensips/README.md

@@ -0,0 +1,5 @@
+# OpenSIPS
+
+*Under construction*
+
+Collects OpenSIPS metrics

+ 1 - 1
collectors/checks.plugin/README.md

@@ -1,3 +1,3 @@
-# Netdata internal checks
+# checks.plugin
 
 A debugging plugin (by default it is disabled)

+ 1 - 1
collectors/freebsd.plugin/README.md

@@ -1,3 +1,3 @@
-# freebsd
+# freebsd.plugin
 
 Collects resource usage and performance data on FreeBSD systems

Некоторые файлы не были показаны из-за большого количества измененных файлов