summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-05-19 12:56:52 -0700
committerGitHub <noreply@github.com>2020-05-19 12:56:52 -0700
commit000197b770d4eeae10c6841bc6228e07a690c524 (patch)
treedb866929af654bcf6292ece17c75aeb2b2bcab29 /docs
parentdd41f529f0fdfbafd7e4d042dffe4160b852bff5 (diff)
Docs: Update contributing guidelines (#8781)
* Update docs contributing * Remove other instances of docs.netdata.cloud * Rebase and add a few more updates * Cleanup, descriptions, grammar check * Fix link * Add text about Cloud docs, links, fixes for Zack
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md11
-rw-r--r--docs/contributing/contributing-documentation.md140
-rw-r--r--docs/contributing/style-guide.md132
-rw-r--r--docs/step-by-step/step-99.md4
-rw-r--r--docs/what-is-netdata.md4
5 files changed, 126 insertions, 165 deletions
diff --git a/docs/README.md b/docs/README.md
index 1097e5a839..c483cb7ad1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,14 +1,17 @@
<!--
---
-title: "Read documentation on <https://docs.netdata.cloud>"
+title: "Read documentation on <https://learn.netdata.cloud>"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
---
-->
-# Read documentation on <https://docs.netdata.cloud>
+# Read documentation on <https://learn.netdata.cloud>
-Welcome to the Netdata documentation! While you can read Netdata documentation here, or throughout the Netdata repository, our intention is that these pages are read on [docs.netdata.cloud](https://docs.netdata.cloud).
+Welcome to the Netdata documentation! While you can read Netdata documentation here, or throughout the Netdata
+repository, our intention is that these pages are read on [learn.netdata.cloud](https://learn.netdata.cloud).
-Links between documentation pages will work fine here, but the formatting may not be perfect, as our documentation site uses a few extra Markdown features that GitHub doesn't support natively. Other things might be missing or look less than perfect.
+Links between documentation pages will work fine here, but the formatting may not be perfect, as our documentation site
+uses a few extra Markdown features that GitHub doesn't support natively. Other things might be missing or look less than
+perfect.
Now get out there and build an exceptional infrastructure.
diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md
index b3ee12025d..76afe22ee7 100644
--- a/docs/contributing/contributing-documentation.md
+++ b/docs/contributing/contributing-documentation.md
@@ -1,25 +1,34 @@
<!--
title: "Contributing to documentation"
+description: "Want to contribute to Netdata's documentation? This guide will set you up with the tools to help others learn about health and performance monitoring."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md
-->
# Contributing to documentation
-We welcome contributions to Netdata's already extensive documentation, which we host at
-[docs.netdata.cloud](https://docs.netdata.cloud/) and store inside of the [main
-repository](https://github.com/netdata/netdata) on GitHub.
+We welcome contributions to Netdata's already extensive documentation. We store documentation related to our open source
+monitoring Agent inside of the [`netdata/netdata` repository](https://github.com/netdata/netdata) on GitHub.
+
+Documentation related to Netdata Cloud is stored in a private repository and is not currently open to community
+contributions.
+
+All our documentation is aggregated and published at [learn.netdata.cloud](https://learn.netdata.cloud/).
Like all contributing to all other aspects of Netdata, we ask that anyone who wants to help with documentation read and
abide by the [Contributor Convenant Code of Conduct](/CODE_OF_CONDUCT.md) and follow the
instructions outlined in our [Contributing document](/CONTRIBUTING.md).
-We also ask you to read our [documentation style guide](style-guide.md), which, while not complete, will give you some
-guidance on how we write and organize our documentation.
+We also ask you to read our [documentation style guide](/docs/contributing/style-guide.md), which, while not complete,
+will give you some guidance on how we write and organize our documentation.
All our documentation uses the Markdown syntax. If you're not familiar with how it works, please read the [Markdown
introduction post](https://daringfireball.net/projects/markdown/) by its creator, followed by [Mastering
Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub.
+Our [documentation site](https://learn.netdata.cloud/) is built with [Docusaurus](https://v2.docusaurus.io/). If you
+want to contribute to the generated documentation site, and have experience in React and/or Docusaurus itself, send us
+an email: [info@netdata.cloud](mailto:info@netdata.cloud).
+
## How contributing to the documentation works
There are two ways to contribute to Netdata's documentation:
@@ -27,12 +36,11 @@ There are two ways to contribute to Netdata's documentation:
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-github).
2. Download the repository and [edit documentation locally](#edit-documentation-locally).
-Editing in GitHub is a simpler process and is perfect for quick edits to a single document, such as fixing a typo or
-clarifying a confusing sentence.
+Editing in GitHub is a more straightforward process and is perfect for quick edits to a single document, such as fixing
+a typo or clarifying a confusing sentence.
-Editing locally is more complex, as you need to download the Netdata repository and build the documentation using
-`mkdocs`, but allows you to better organize complex projects. By building documentation locally, you can preview your
-work using a local web server before you submit your PR.
+Editing locally is more complicated but allows you to organize complex projects. By building documentation locally, you
+can preview your work using a local web server before you submit your PR.
In both cases, you'll finish by submitting a pull request (PR). Once you submit your PR, GitHub will initiate a number
of jobs, including a Netlify preview. You can use this preview to view the documentation site with your changes applied,
@@ -46,7 +54,7 @@ To continue, follow one of the paths below:
## Edit documentation directly on GitHub
Start editing documentation on GitHub by clicking the small pencil icon on any page on Netdata's [documentation
-site](https://docs.netdata.cloud/). You can find them at the top of every page.
+site](https://learn.netdata.cloud/). You can find them at the top of every page.
Clicking on this icon will take you to the associated page in the `netdata/netdata` repository. Then click the small
pencil icon on any documentation file (those ending in the `.md` Markdown extension) in the `netdata/netdata`
@@ -59,23 +67,19 @@ If you know where a file resides in the Netdata repository already, you can skip
documentation site and go directly to GitHub.
Once you've clicked the pencil icon on GitHub, you'll see a full Markdown version of the file. Make changes as you see
-fit. You can use the `Preview changes` button to ensure your Markdown syntax is working properly.
+fit. You can use the **Preview changes** button to ensure your Markdown syntax is working correctly.
-Under the `Propose file change` header, write in a descriptive title for your requested change. Beneath that, add a
-concise descrition of what you've changed and why you think it's important. Then, click the `Propose file change`
-button.
+Under the **Propose file change** header, write in a descriptive title for your requested change. Beneath that, add a
+concise description of what you've changed and why you think it's essential. Then, click the **Propose file change**
+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.
-
-> 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.
+cleanup](#pull-requests-and-final-steps) for your next steps.
## Edit documentation locally
Editing documentation locally is the preferred method for complex changes, PRs that span across multiple documents, or
-those that change the styling or underlying functionality of the documentation.
+those that change the documentation's style or underlying functionality.
Here is the workflow for editing documentation locally. First, create a fork of the Netdata repository, if you don't
have one already. Visit the [Netdata repository](https://github.com/netdata/netdata) and click on the `Fork` button in
@@ -84,7 +88,7 @@ the upper-right corner of the window.
![Screenshot of forking the Netdata
repository](https://user-images.githubusercontent.com/1153921/59873572-25f5a380-9351-11e9-92a4-a681fe4a2ed9.png)
-GitHub will ask you where you want to clone the repository, and once finished you'll end up at the index of your forked
+GitHub will ask you where you want to clone the repository, and once finished, you end up at the index of your forked
Netdata repository. Clone your fork to your local machine:
```bash
@@ -95,107 +99,51 @@ You can now jump into the directory and explore Netdata's structure for yourself
### Understanding the structure of Netdata's documentation
-All of Netdata's documentation is stored within the repository itself, as close as possible to the code it corresponds
-to. Many sub-folders contain a `README.md` file, which is then used to populate the documentation about that
+All of Netdata's documentation is stored within the `netdata/netdata` repository, as close as possible to the code it
+corresponds to. Many sub-folders contain a `README.md` file, which is then used to populate the documentation about that
feature/component of Netdata.
-For example, the file at `packaging/installer/README.md` becomes `https://docs.netdata.cloud/packaging/installer/` and
-is our installation documentation. By co-locating it with quick-start installtion code, we ensure documentation is
-always tightly-knit with the functions it describes.
+For example, the installation documentation at `packaging/installer/README.md` becomes
+`https://learn.netdata.cloud/docs/agent/packaging/installer/`. By co-locating it with quick-start installation code, we
+ensure documentation is always tightly-knit with the functions it describes.
You might find other `.md` files within these directories. The `packaging/installer/` folder also contains `UPDATE.md`
-and `UNINSTALL.md`, which become `https://docs.netdata.cloud/packaging/installer/update/` and
-`https://docs.netdata.cloud/packaging/installer/uninstall/`, respectively.
+and `UNINSTALL.md`, which become `https://learn.netdata.cloud/docs/agent/packaging/installer/update/` and
+`https://learn.netdata.cloud/docs/agent/packaging/installer/uninstall/`, respectively.
If the documentation you're working on has a direct correlation to some component of Netdata, place it into the correct
folder and either name it `README.md` for generic documentation, or with another name for very specific instructions.
#### The `docs` folder
-At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have
+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.
-If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in
+If the documentation you're working on doesn't have a direct relationship to a component of Netdata, you can place it in
this `docs/` folder.
+These documents will end up at the "root" of the Agent documentation at `https://learn.netdata.cloud/docs/agent/`. For
+example, the file at `docs/getting-started.md` becomes `https://learn.netdata.cloud/docs/agent/getting-started/`.
+
### Make your edits
Now that you're set up and understand where to find or create your `.md` file, you can now begin to make your edits.
Just use your favorite editor and keep in mind our [style guide](style-guide.md) as you work.
-If you add a new file to the documentation, you may need to modify the `buildyaml.sh` file to ensure it's added to the
-site's navigation. This is true for any file added to the `docs/` folder.
-
Be sure to periodically add/commit your edits so that you don't lose your work! We use version control software for a
reason.
-### Build the documentation
-
-Building the documentation periodically gives you a glimpse into the final product, and is generally required if you're
-making changes to the table of contents.
-
-We have a [netdata/docs Docker Image](https://hub.docker.com/r/netdata/os-test) available on the Docker Hub
-that greatly simplifies building the documentation on any [Docker](https://www.docker.com) supported platform.
-
-To build the docs using this image via Docker simply run the following commands in your shell:
-
-```bash
-cd /path/to/netdata
-docker run -i -t -v $PWD:/netdata netdata/docs
-```
-
-----
-
-if you are using a GNU/Linux based system for developing / contribiting to our documentation, you may build the
-docs with the provided Shell scripts in `./docs/generator/buildhtml.sh`. This requires GNU Bash and findutils
-as well as Python/pip and some Python packages `mkdocs` and `mkdocs-material` installed in your environment.
-
-Follow the [Python installation instructions](https://www.python.org/downloads/) for your machine.
-
-Use `pip`, which was installed alongside Python, to install `mkdocs` and `mkdocs-material`. Your operating system might
-force you to use `pip2` or `pip3` instead, depending on which version of Python you have installed.
-
-```bash
-pip install mkdocs mkdocs-material --user
-```
-
-> If you're having trouble with the installation of Python, `mkdocs`, or `mkdocs-material`, try looking into the
-> `mkdocs` [installation instructions](https://squidfunk.github.io/mkdocs-material/getting-started/#installation).
-
-When `pip` is finished installing, navigate to the root directory of the Netdata repository and run the documentation
-generator script.
-
-```bash
-sh docs/generator/buildhtml.sh
-```
-
-This process will take some time. Once finished, the built documentation site will be located at
-`docs/generator/build/`.
-
-### Run a local web server to test documentation
-
-The best way to view the documentation site you just built is to run a simple web server from the
-`docs/generator/build/` directory. So, navigate there and run a Python-based web server:
-
-```sh
-cd docs/generator/build/
-python3 -m http.server 20000
-```
-
-Feel free to replace the port number you want this web server to listen on (port `20000` in this case (only one higher
-than the agent!)).
-
-Open your web browser and navigate to `http://localhost:20000`. If you replaced the port earlier, change it here as
-well. You can now navigate through the documentation as you would on the live site!
-
## Pull requests and final steps
-When you're finished with your changes, add and commit them to your fork of the Netdata repository. Head over to GitHub
-to create your pull request (PR).
+When you finish with your changes, add and commit them to your fork of the Netdata repository. Head over to GitHub to
+create your pull request (PR).
-Once we receive your pull request (PR), we'll take time to read through it and assess it for correctness, conciseness,
+Once we receive your pull request (PR), the Netdata team reads through it and assesses it for correctness, conciseness,
and overall quality. We may point to specific sections and ask for additional information or other fixes.
+After merging your PR, we then rebuild the [documentation site](https://learn.netdata.cloud), which is built with
+[Docusaurus](https://v2.docusaurus.io/). You can then also delete your branch
+
## What's next
- Read up on the Netdata documentation [style guide](style-guide.md).
diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md
index 72f93b0fd9..7f0936c2ad 100644
--- a/docs/contributing/style-guide.md
+++ b/docs/contributing/style-guide.md
@@ -1,5 +1,6 @@
<!--
title: "Netdata style guide"
+description: "Learn about Netdata's writing and Markdown standards for documentation and educational content."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md
-->
@@ -21,9 +22,9 @@ products.
## Welcome
Proper documentation is essential to the success of any open-source project. Netdata is no different. The health of our
-monitoring agent, and the community it's created, depends on this effort.
+monitoring agent and our community depends on this effort.
-We’re here to make developers, sysadmins, and DevOps engineers better at their jobs, after all!
+We're here to make developers, sysadmins, and DevOps engineers better at their jobs, after all!
We welcome contributions to Netdata's documentation. Begin with the [contributing to documentation
guide](contributing-documentation.md), followed by this style guide.
@@ -38,8 +39,8 @@ following principles:
- Conciseness
- Accessibility
-These principles will make documentation better for everyone who wants to use Netdata, whether they're a beginner or an
-expert.
+These principles will make the documentation better for everyone who wants to use Netdata, whether they're a beginner or
+an expert.
### Breaking the rules
@@ -53,21 +54,22 @@ process.
Yes, this style guide is pretty overwhelming! Establishing standards for a global community is never easy.
-Here's a few key points to start with. Where relevant, they link to more in-depth information about a given rule.
+Let's start with a few key points to start. Where relevant, these points link to more in-depth information about a given
+rule.
**[Tone and content](#tone-and-content)**:
- Be [conversational and friendly](#conversational-and-friendly-tone).
- Write [concisely](#write-concisely).
- Don't use words like **here** when [creating hyperlinks](#use-informational-hyperlinks).
-- Don't mention [future releases or features](#mentioning-future-releases-or-features) in documentation.
+- Don't mention [future releases or features](#mentioning-future-releases-or-features) in the documentation.
**[Language and grammar](#language-and-grammar)**:
- [Capitalize words](#capitalization) at the beginning of sentences, for proper nouns, and at the beginning of
document titles and section headers.
- Use [second person](#second-person)—"you" rather than "we"—when giving instructions.
-- Use [active voice](#active-voice) to make clear who or what is performing an action.
+- Use [active voice](#active-voice) to make clear who or what is acting.
- Always employ an [Oxford comma](#oxford-comma) on lists.
**[Markdown syntax](#markdown-syntax)**:
@@ -84,8 +86,7 @@ Here's a few key points to start with. Where relevant, they link to more in-dept
## Tone and content
-Netdata's documentation should be conversational, concise, and informational, without feeling formal. This isn't a
-textbook. It's a repository of information that should (on occasion!) encourage and excite its readers.
+Netdata's documentation should be conversational, concise, and informational, without feeling overly formal.
By following a few principles on tone and content we'll ensure more readers from every background and skill level will
learn as much as possible about Netdata's capabilities.
@@ -126,7 +127,7 @@ include as many hyperlinks as necessary to provide meaningful context.
Never assume readers of Netdata documentation are experts in Netdata's inner workings or health monitoring/performance
troubleshooting in general.
-If you claim that a task is easy and the reader struggles to complete it, they'll get discouraged.
+If you claim that a task is easy and the reader struggles to complete it, you may inadvertently discourage them.
If you perceive one option to be easier than another, be specific about how and why. For example, don't write,
"Netdata's one-line installer is the easiest way to install Netdata." Instead, you might want to say, "Netdata's
@@ -135,10 +136,13 @@ one-line installer requires fewer steps than manually installing from source."
### Avoid slang, metaphors, and jargon
A particular word, phrase, or metaphor you're familiar with might not translate well to the other cultures featured
-among Netdata's global community. It's recommended you avoid slang or colloquialisms in your writing.
+among Netdata's global community. We recommended you avoid slang or colloquialisms in your writing.
-If you must use industry jargon, such as "white-box monitoring," in a document, be sure to define the term as clearly
-and concisely as you can.
+In addition, don't use abbreviations that have not yet been defined in the document. See our section on
+[abbreviations](#abbreviations-acronyms-and-initialisms) for more information.
+
+If you must use industry jargon, such as "white-box monitoring," in a document, define the term as clearly and concisely
+as you can.
> White-box monitoring: Monitoring of a system or application based on the metrics it directly exposes, such as logs.
@@ -159,13 +163,13 @@ sections will outline the preferred usage for capitalization, point of view, act
### Capitalization
-In text, follow the general [English
-standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for capitalization. In summary:
+Follow the general [English standards](https://owl.purdue.edu/owl/general_writing/mechanics/help_with_capitals.html) for
+capitalization. In summary:
- Capitalize the first word of every new sentence.
- Don't use uppercase for emphasis. (Netdata is the BEST!)
- Capitalize the names of brands, software, products, and companies according to their official guidelines. (Netdata,
- Docker, Apache, Nginx)
+ Docker, Apache, NGINX)
- Avoid camel case (NetData) or all caps (NETDATA).
#### Capitalization of 'Netdata' and 'netdata'
@@ -177,14 +181,19 @@ However, if you are referring to a process, user, or group on a Linux system, yo
those are typically lowercased. In this case, you should also fence these terms in an inline code block: `` `netdata`
``.
-```
+```markdown
# Not recommended
The netdata agent, which spawns the netdata process, is actively maintained by netdata, inc.
# Recommended
-The Netdata agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc.
+The Netdata Agent, which spawns the `netdata` process, is actively maintained by Netdata, Inc.
```
+#### Capitalization of 'Agent' and 'Cloud'
+
+Netdata is split into two products: the open source monitoring **Agent**, and the closed source web application
+**Cloud**. Because both Agent and Cloud are formal nouns, you should capitalize them.
+
#### Capitalization of document titles and page headings
Document titles and page headings should use sentence case. That means you should only capitalize the first word.
@@ -194,13 +203,17 @@ guidelines.
Also, don't put a period (`.`) or colon (`:`) at the end of a title or header.
-**Document titles**:
+```markdown
+# Not recommended
+Getting Started Guide
+Service Discovery and Auto-Detection:
+Install netdata with docker
-| Capitalization | Not recommended | Recommended
-| --- | --- | ---
-| Document titles | Getting Started Guide | Getting started guide
-| Page headings | Service Discovery and Auto-Detection: | Service discovery and auto-detection
-| Proper nouns | Install netdata with docker | Install Netdata with Docker
+# Recommended
+Getting started guide
+Service discovery and auto-detection
+Install Netdata with Docker
+```
### Second person
@@ -213,7 +226,7 @@ Avoid using "we," "I," "let's," and "us" in documentation whenever possible.
The "you" pronoun can also be implied, depending on your sentence structure.
-```
+```markdown
# Not recommended
To install Netdata, we should try the one-line installer...
@@ -226,10 +239,10 @@ To install Netdata, try the one-line installer...
### Active voice
-Use active voice instead of passive voice, because active voice is more concise and easier to understand.
+Use active voice instead of passive voice, because the active voice is more concise and easier to understand.
-When using voice, the subject of the sentence is performing the action. In passive voice, the subject is being acted
-upon. A famous example of passive voice is the phrase "mistakes were made."
+When using voice, the subject of the sentence is action. In passive voice, the subject is acted upon. A famous example
+of passive voice is the phrase "mistakes were made."
```plain
# Not recommended (passive)
@@ -242,7 +255,7 @@ When a metric triggers an alarm, Netdata sends a notification...
### Standard American spelling
While the Netdata team is mostly _not_ American, we still aspire to use American spelling whenever possible, as it is
-more commonly used within the monitoring industry.
+the standard for the monitoring industry.
### Clause order
@@ -257,8 +270,8 @@ Read the reference guide if you'd like to learn more about custom dashboards.
If you'd like to learn more about custom dashboards, read the reference guide.
```
-By placing the circumstance at the beginning of the sentence, those who don't want to follow can stop reading and move
-on. Those who _do_ want to read it are less likely to skip over the sentence.
+By placing the circumstance at the beginning of the sentence, readers can immediately know if they want to read more or
+follow a link.
### Oxford comma
@@ -276,7 +289,7 @@ Netdata can monitor RAM, disk I/O, MySQL queries per second, and lm-sensors.
### Abbreviations (acronyms and initialisms)
Use abbreviations (including [acronyms and initialisms](https://www.dictionary.com/e/acronym-vs-abbreviation/)) in
-documentation when one exists, when it's widely-accepted within the monitoring/sysadmin community, and when it improves
+documentation when one exists, when it's widely accepted within the monitoring/sysadmin community, and when it improves
the readability of a document.
When introducing an abbreviation to a document for the first time, give the reader both the spelled-out version and the
@@ -303,13 +316,22 @@ The Netdata documentation uses the Markdown syntax for styling and formatting. I
please read the [Markdown introduction post](https://daringfireball.net/projects/markdown/) by its creator, followed by
[Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub.
-We also leverage the power of the [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/), which
-features several [extensions](https://squidfunk.github.io/mkdocs-material/extensions/admonition/), such as the ability
-to create notes, warnings, and collapsible blocks.
-
You can follow the syntax specified in the above resources for the majority of documents, but the following sections
specify a few particular use cases.
+### Linking between documents
+
+Documentation should link to relevant pages whenever it's relevant and provides valuable context to the reader. To
+ensure links function properly on both GitHub and our generated documentation on [Netdata
+Learn](https://learn.netdata.cloud/), links should always reference the full path to the document, beginning at the root
+of the Agent repository (`/`). Links should also always end with the filename of the destination document, ending in the
+`.md` extension.
+
+Avoid relative links or traversing up directories using `../`.
+
+For example, if you want to link to our installation guide, you should link to `/packaging/installer/README.md`. To
+reference the guide for increasing metrics storage, use `/docs/tutorials/longer-metrics-storage.md`.
+
### References to UI elements
If you need to instruct your reader to click a user interface (UI) element inside of a Netdata interface, you should
@@ -319,23 +341,17 @@ reference the label text of the link/button with Markdown's (`**bold text**`) ta
Click on the **Sign in** button.
```
-> 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.
+> ⚠️ 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.
-We're also working to establish standards for how we refer to certain elements of the Netdata's web interface. We'll include that in this style guide as soon as it's complete.
-
### Language-specific syntax highlighting in code blocks
-Our documentation uses the [Highlight
-extension](https://facelessuser.github.io/pymdown-extensions/extensions/highlight/) for syntax highlighting. Highlight
-is fully compatible with [Pygments](http://pygments.org/), allowing you to highlight the syntax within code blocks in a
-number of interesting ways.
-
-For a full list of languages, see [Pygment's supported languages](http://pygments.org/languages/). Netdata documentation
-will use the following for the most part: `c`, `python`, `js`, `shell`, `markdown`, `bash`, `css`, `html`, and `go`. If
-no language is specified, the Highlight extension doesn't apply syntax highlighting.
+Our documentation site at [learn.netdata.cloud](https://learn.netdata.cloud) uses
+[Prism](https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting) for syntax highlighting. Netdata
+documentation will use the following for the most part: `c`, `python`, `js`, `shell`, `markdown`, `bash`, `css`, `html`,
+and `go`. If no language is specified, Prism tries to guess the language based on its content.
Include the language directly after the three backticks (```` ``` ````) that start the code block. For highlighting C
code, for example:
@@ -360,15 +376,10 @@ inline char *health_stock_config_dir(void) {
}
```
-You can also use the Highlight and
-[SuperFences](https://facelessuser.github.io/pymdown-extensions/extensions/superfences/) extensions together to show
-line numbers or highlight specific lines.
-
-Display line numbers by appending `linenums="1"` after the language declaration, replacing `1` with the starting line
-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`.
+Prism also supports titles and line highlighting. See the [Docusaurus
+documentation](https://v2.docusaurus.io/docs/markdown-features#code-blocks) for more information.
-> Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on our
+> ⚠️ 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
@@ -379,10 +390,9 @@ some additional rules to improve the reading experience for all readers.
### Images
-Images are an important component to documentation, which is why we have a few rules around their usage.
-
-Perhaps most importantly, don't use only images to convey instructions. Each image should be accompanied by alt text and
-text-based instructions to ensure that every reader can access the information in the best way for them.
+We have a few rules around using images. Perhaps most importantly, don't use only images to convey instructions. Each
+image should be accompanied by alt text and text-based instructions to ensure that every reader can access the
+information in the best way for them.
#### Alt text
@@ -392,7 +402,7 @@ the image.
In Markdown, use the standard image syntax, `![]()`, and place the alt text between the brackets `[]`. Here's an example
using our logo:
-```
+```markdown
![The Netdata logo](../../web/gui/images/netdata-logomark.svg)
```
diff --git a/docs/step-by-step/step-99.md b/docs/step-by-step/step-99.md
index 16b8121b91..3740832b6a 100644
--- a/docs/step-by-step/step-99.md
+++ b/docs/step-by-step/step-99.md
@@ -15,8 +15,8 @@ our toolkit for health monitoring and performance troubleshooting.
But, perhaps more importantly, also that much closer to being an expert in the _fundamental skills behind health
monitoring and performance troubleshooting_, which you can take with you to any job or project.
-And that is the entire point of this tutorial, and Netdata's [documentation](https://docs.netdata.cloud) as a whole—give
-you every resource possible to help you build faster, more resilient systems, services, and applications.
+And that is the entire point of this tutorial, and Netdata's [documentation](https://learn.netdata.cloud) as a
+whole—give you every resource possible to help you build faster, more resilient systems, services, and applications.
Along the way, you learned how to:
diff --git a/docs/what-is-netdata.md b/docs/what-is-netdata.md
index 684a34164b..2f00db22e6 100644
--- a/docs/what-is-netdata.md
+++ b/docs/what-is-netdata.md
@@ -357,7 +357,7 @@ write a collector for your custom application using our [plugin API](/collectors
## Documentation
-The Netdata documentation is at <https://docs.netdata.cloud>, but you can also find each page inside of Netdata's
+The Netdata documentation is at <https://learn.netdata.cloud>, but you can also find each page inside of Netdata's
repository itself in Markdown (`.md`) files. You can find all our documentation by navigating the repository.
Here is a quick list of notable documents:
@@ -394,7 +394,7 @@ You can also find Netdata on:
## License
-Netdata is [GPLv3+](/LICENSE).
+Netdata is [GPLv3+](https://github.com/netdata/netdata/blob/master/LICENSE).
Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](/REDISTRIBUTED.md).