diff options
author | Joel Hans <joel@netdata.cloud> | 2020-05-11 08:48:23 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-11 08:48:23 -0700 |
commit | 74fda3de8e45e4211da8a574daabbfc30c74f0a9 (patch) | |
tree | bcb5fb2a9ce32f759ca7bb139fb6e9da70e2126e /docs | |
parent | 9e8a0e173e2f4402fb081950b4b25d5fc0b62492 (diff) |
Docs: Fix internal links and remove obsolete admonitions (#8946)
* Fixed a few more links
* Remove old syntax
* Abs-relative links to files in docs folder
* Trying to fix nother doc learn link
* Fix a few more links
* Add testing doc
* Tracking down mysteries
* Cleanup
* Update broken external links
* Remove index.html that appeared from testing
* Fix remainder of links
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Donations-netdata-has-received.md | 1 | ||||
-rw-r--r-- | docs/Running-behind-haproxy.md | 9 | ||||
-rw-r--r-- | docs/anonymous-statistics.md | 2 | ||||
-rw-r--r-- | docs/contributing/contributing-documentation.md | 11 | ||||
-rw-r--r-- | docs/contributing/style-guide.md | 16 | ||||
-rw-r--r-- | docs/tutorials/collect-apache-nginx-web-logs.md | 9 | ||||
-rw-r--r-- | docs/tutorials/monitor-cockroachdb.md | 5 |
7 files changed, 25 insertions, 28 deletions
diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md index 588229378f..2c75b87436 100644 --- a/docs/Donations-netdata-has-received.md +++ b/docs/Donations-netdata-has-received.md @@ -18,7 +18,6 @@ This is a list of the donations we have received for Netdata (sorted alphabetica | Cloud VMs|[london.my-netdata.io](https://london.my-netdata.io) (Several VMs)|**[DigitalOcean.com](https://www.digitalocean.com/)**|**DigitalOcean.com** donated 1000 USD to be used in their excellent Cloud Computing services. Many thanks to [Justin Paine](https://github.com/xxdesmus) for making this happen.| | Development IDE|-|**[JetBrains.com](https://www.jetbrains.com/)**|**JetBrains.com** donated an open source license for 4 developers for 1 year, to their excellent IDEs.| | Cloud VM|[octopuscs.my-netdata.io](https://octopuscs.my-netdata.io)|**[OctopusCS.com](https://octopuscs.com/)**|**OctopusCS.com** donated a VM with 4 CPU cores, 16GB RAM and 50GB HD in their excellent Cloud Computing services.| -| Cloud VM|[ventureer.my-netdata.io](https://ventureer.my-netdata.io)|**[Ventureer.com](https://ventureer.com/)**|**Ventureer.com** donated a VM with 4 CPU cores, 8GB RAM and 50GB HD in their excellent Cloud Computing services.| | Cloud VM|[stackscale.my-netdata.io](https://stackscale.my-netdata.io)|**[stackscale.com](https://www.stackscale.com/)**|**StackScale.com** donated a VM with 4 CPU cores, 16GB RAM and 100GB HD in their excellent Cloud Computing services.| Thank you! diff --git a/docs/Running-behind-haproxy.md b/docs/Running-behind-haproxy.md index 28e7761563..bf6ae76a12 100644 --- a/docs/Running-behind-haproxy.md +++ b/docs/Running-behind-haproxy.md @@ -11,9 +11,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-beh > and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites > and powers quite a number of the world's most visited ones. -If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name -can be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to -connect to Netdata at <https://example.com> or <https://example.com/netdata/>, which is a much nicer experience then <http://example.com:19999>. +If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name can +be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to connect to +Netdata at `https://example.com` or `https://example.com/netdata/`, which is a much nicer experience then +`http://example.com:19999`. To proxy requests from [HAProxy](https://github.com/haproxy/haproxy) to Netdata, the following configuration can be used: @@ -29,7 +30,7 @@ defaults ## Simple Configuration -A simple example where the base URL, say <http://example.com>, is used with no subpath: +A simple example where the base URL, say `http://example.com`, is used with no subpath: ### Frontend diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index 46bf06bcec..71c995a519 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -97,7 +97,7 @@ update. You can also export the environment variable `DO_NOT_TRACK` with a non-z When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker -image](/packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable +image](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for the first time, this variable will disable the anonymous statistics script inside of the container. Each of these opt-out processes does the following: diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index 9347bccabc..b3ee12025d 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -1,8 +1,6 @@ <!-- ---- title: "Contributing to documentation" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md ---- --> # Contributing to documentation @@ -70,9 +68,9 @@ button. After you've hit that button, jump down to our instructions on [pull requests and cleanup](#pull-requests-and-final-steps) for your next steps. -!!! note This process will create a branch directly on the `netdata/netdata` repository, which then requires manual - cleanup. If you're going to make significant documentation contributions, or contribute often, we recommend the - local editing process just below. +> This process will create a branch directly on the `netdata/netdata` repository, which then requires manual cleanup. If +> you're going to make significant documentation contributions, or contribute often, we recommend the local editing +> process just below. ## Edit documentation locally @@ -115,8 +113,7 @@ folder and either name it `README.md` for generic documentation, or with another #### The `docs` folder At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have -a direct relationship to a specific component of Netdata. It's where we house our [getting started -guide](/docs/getting-started.md), guides on [running Netdata behind Nginx](/docs/Running-behind-nginx.md), and more. +a direct relationship to a specific component of Netdata. If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in this `docs/` folder. diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 6ff684e406..72f93b0fd9 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -1,8 +1,6 @@ <!-- ---- title: "Netdata style guide" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md ---- --> # Netdata style guide @@ -112,12 +110,12 @@ Conciseness leads to more accurate and understandable writing. Hyperlinks should clearly state its destination. Don't use words like "here" to describe where a link will take your reader. -``` +```markdown # Not recommended -To install Netdata, click [here](https://docs.netdata.cloud/packaging/installer/). +To install Netdata, click [here](/packaging/installer/README.md). # Recommended -To install Netdata, read our [installation instructions](https://docs.netdata.cloud/packaging/installer/). +To install Netdata, read our [installation instructions](/packaging/installer/README.md). ``` In general, guides should include fewer hyperlinks to keep the reader focused on the task at hand. Documentation should @@ -321,8 +319,8 @@ reference the label text of the link/button with Markdown's (`**bold text**`) ta Click on the **Sign in** button. ``` -!!! note Whenever possible, avoid using directional language to orient readers, because not every reader can use - instructions like "look at the top-left corner" to find their way around an interface. +> Whenever possible, avoid using directional language to orient readers, because not every reader can use instructions +> like "look at the top-left corner" to find their way around an interface. If you feel that you must use directional language, perhaps use an [image](#images) (with proper alt text) instead. @@ -370,8 +368,8 @@ Display line numbers by appending `linenums="1"` after the language declaration, number of your choice. Highlight lines by appending `hl_lines="2"`, replacing `2` with the line you'd like to highlight. Or, multiple lines: `hl_lines="1 2 4 12`. -!!! note Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on - our [documentation site](https://docs.netdata.cloud/). They should be used sparingly and only when necessary. +> Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on our +> [documentation site](https://learn.netdata.cloud/). They should be used sparingly and only when necessary. ## Accessibility diff --git a/docs/tutorials/collect-apache-nginx-web-logs.md b/docs/tutorials/collect-apache-nginx-web-logs.md index d797cf1960..0afa9189d3 100644 --- a/docs/tutorials/collect-apache-nginx-web-logs.md +++ b/docs/tutorials/collect-apache-nginx-web-logs.md @@ -130,8 +130,9 @@ web server's access log and begin showing real-time charts! The web log collector is capable of parsing custom Nginx and Apache log formats and presenting them as charts, but we'll leave that topic for a separate tutorial. -We do have [extensive documentation](/collectors/go.d.plugin/modules/weblog/README.md#custom-log-format) on how to build -custom parsing for Nginx and Apache logs. +We do have [extensive +documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/#custom-log-format) on how +to build custom parsing for Nginx and Apache logs. ## Tweak web log collector alarms @@ -153,8 +154,8 @@ documentation](/health/README.md). ## What's next? Now that you have web log collection up and running, we recommend you take a look at the documentation for our -[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring" -logs into powerful real-time tools for keeping your servers happy. +[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring" logs +into powerful real-time tools for keeping your servers happy. Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go refactoring effort. diff --git a/docs/tutorials/monitor-cockroachdb.md b/docs/tutorials/monitor-cockroachdb.md index e4c54fffaa..43d9cf2c65 100644 --- a/docs/tutorials/monitor-cockroachdb.md +++ b/docs/tutorials/monitor-cockroachdb.md @@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/m [CockroachDB](https://github.com/cockroachdb/cockroach) is an open-source project that brings SQL databases into scalable, disaster-resilient cloud deployments. Thanks to a [new CockroachDB -collector](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/) released in +collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) released in [v1.20](https://blog.netdata.cloud/posts/release-1.20/), you can now monitor any number of CockroachDB databases with maximum granularity using Netdata. Collect more than 50 unique metrics and put them on interactive visualizations designed for better visual anomaly detection. @@ -122,7 +122,8 @@ thoughts. Also, be sure to check out these useful resources: -- [Netdata's CockroachDB documentation](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/) +- [Netdata's CockroachDB + documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) - [Netdata's CockroachDB configuration](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/cockroachdb.conf) - [Netdata's CockroachDB |