Implement OpenGraph and basic Schema tags (#8224)
* Implement OpenGraph and basic Schema tags * Better description * Cleanup and smush * Remove extra 2 * Shorter description
Joel Hans committed
Feb 28, 2020 at 12:01 UTC
a04632ab3b334b97a228c5905bbb79c0d24c4cb2
4 files changed
+83
-20
docs/generator/buildyaml.sh
+20
-20
@@ -62,41 +62,41 @@ navpart() {
62
done
63
}
64
65
-echo -e 'site_name: Netdata Documentation
65
+echo -e "site_name: Netdata Documentation
66
site_url: https://docs.netdata.cloud
67
repo_url: https://github.com/netdata/netdata
68
repo_name: GitHub
69
edit_uri: blob/master
70
-site_description: Netdata Documentation
71
-copyright: Netdata, 2019
70
+site_description: Learn about Netdata's real-time health monitoring and performance troubleshooting for all your systems and applications.
71
+copyright: Netdata, 2020
72
docs_dir: '${docs_dir}'
73
site_dir: '${site_dir}'
74
#use_directory_urls: false
75
strict: true
76
extra:
77
social:
78
- - type: "github"
79
- link: "https://github.com/netdata/netdata"
80
- - type: "twitter"
81
- link: "https://twitter.com/linuxnetdata"
82
- - type: "facebook"
83
- link: "https://www.facebook.com/linuxnetdata/"
78
+ - type: github
79
+ link: https://github.com/netdata/netdata
80
+ - type: twitter
81
+ link: https://twitter.com/linuxnetdata
82
+ - type: facebook
83
+ link: https://www.facebook.com/linuxnetdata/
84
theme:
85
- name: "material"
85
+ name: material
86
palette:
87
- primary: "blue grey"
88
- accent: "light green"
87
+ primary: 'blue grey'
88
+ accent: 'light green'
89
custom_dir: custom/themes/material
90
favicon: custom/img/favicon.ico
91
logo: custom/img/netdata_logo.svg
92
language: '${language}'
93
extra_css:
94
- - "https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
95
- - "https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css"
96
- - "custom/css/netdata.css"
94
+ - 'https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css'
95
+ - 'https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css'
96
+ - 'custom/css/netdata.css'
97
extra_javascript:
98
- - "custom/javascripts/cookie-consent.js"
99
- - "https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js"
98
+ - 'custom/javascripts/cookie-consent.js'
99
+ - 'https://cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js'
100
markdown_extensions:
101
- extra
102
- abbr
@@ -111,7 +111,7 @@ markdown_extensions:
111
- smarty
112
- toc:
113
permalink: True
114
- separator: "-"
114
+ separator: '-'
115
- wikilinks
116
- pymdownx.arithmatex
117
- pymdownx.betterem:
@@ -121,7 +121,7 @@ markdown_extensions:
121
- pymdownx.details
122
- pymdownx.highlight:
123
pygments_style: manni
124
- css_class: "highlight codehilite"
124
+ css_class: 'highlight codehilite'
125
linenums_style: pymdownx-inline
126
- pymdownx.inlinehilite
127
- pymdownx.magiclink
@@ -139,7 +139,7 @@ markdown_extensions:
139
- markdown.extensions.tables
140
- markdown.extensions.abbr
141
- pymdownx.extrarawhtml
142
-nav:'
142
+nav:"
143
144
navpart 1 . "README" ""
145
docs/generator/custom/img/netdata_docs.png
Binary files /dev/null and b/docs/generator/custom/img/netdata_docs.png differ
docs/generator/custom/themes/material/main.html
new
+58
@@ -0,0 +1,58 @@
1
+{% extends "base.html" %}
2
+
3
+{% block extrahead %}
4
+
5
+ <meta property="og:url" content="{{ page.canonical_url }}">
6
+ {% if page and page.meta and page.meta.title %}
7
+ <meta property="og:title" content="{{ page.meta.title }}">
8
+ {% elif page and page.title and not page.is_homepage %}
9
+ <meta property="og:title" content="{{ page.title }} - {{ config.site_name }}">
10
+ {% else %}
11
+ <meta property="og:title" content="{{ config.site_name }}">
12
+ {% endif %}
13
+
14
+ {% if page and page.meta and page.meta.description %}
15
+ <meta property="og:description" content="{{ page.meta.description }}">
16
+ {% elif config.site_description %}
17
+ <meta property="og:description" content="{{ config.site_description }}">
18
+ {% endif %}
19
+ <meta property="og:image" content="custom/img/netdata_docs.png">
20
+ <meta property="og:image:alt" content="Netdata documentation: Learn about real-time health monitoring and performance troubleshooting for systems and applications">
21
+ <meta property="og:image:type" content="image/jpeg">
22
+ <meta property="og:image:width" content="1200">
23
+ <meta property="og:image:height" content="630">
24
+
25
+ <meta name="twitter:card" content="summary_large_image">
26
+ <meta name="twitter:site" content="@linuxnetdata">
27
+ <meta name="twitter:creator" content="@linuxnetdata">
28
+ {% if page and page.meta and page.meta.title %}
29
+ <meta property="twitter:title" content="{{ page.meta.title }}">
30
+ {% elif page and page.title and not page.is_homepage %}
31
+ <meta property="twitter:title" content="{{ page.title }} - {{ config.site_name }}">
32
+ {% else %}
33
+ <meta property="twitter:title" content="{{ config.site_name }}">
34
+ {% endif %}
35
+ {% if page and page.meta and page.meta.description %}
36
+ <meta name="twitter:description" content="{{ page.meta.description }}">
37
+ {% elif config.site_description %}
38
+ <meta name="twitter:description" content="{{ config.site_description }}">
39
+ {% endif %}
40
+ <meta name="twitter:image" content="custom/img/netdata_docs.png">
41
+ <meta name="twitter:image:alt" content="Netdata documentation: Learn about real-time health monitoring and performance troubleshooting for systems and applications">
42
+
43
+ <script type="application/ld+json">
44
+ {
45
+ "@context": "http://schema.org",
46
+ "@type": "HowTo",
47
+ {% if page and page.meta and page.meta.title %}"name": "{{ page.meta.title }}",{% elif page and page.title and not page.is_homepage %}"name": "{{ page.title }} - {{ config.site_name }}",{% else %}"name": "{{ config.site_name }}",{% endif %}
48
+ {% if page and page.meta and page.meta.description %}"description": "{{ page.meta.description }}",{% elif config.site_description %}"description": "{{ config.site_description }}",{% endif %}
49
+ "image": {
50
+ "@type": "ImageObject",
51
+ "url": "custom/img/netdata_docs.png",
52
+ "height": "1200",
53
+ "width": "630"
54
+ },
55
+ }
56
+ </script>
57
+
58
+{% endblock %}
\ No newline at end of file
docs/step-by-step/step-00.md
+5
@@ -1,3 +1,8 @@
1
+---
2
+title: The step-by-step Netdata tutorial
3
+description: Learn what Netdata is, what it's capable of, and how it'll help you make faster and more informed decisions about the health and performance of your systems and applications.
4
+---
5
+
6
# The step-by-step Netdata tutorial
7
8
Welcome to Netdata! We're glad you're interested in our health monitoring and performance troubleshooting system.