Merge branch 'main' into jdb/2023-10-data-source-plugin

grafana · Oct 25, 2023 · f16b4d9 · f16b4d9
2 parents 7751b52 + f57cf8e
commit f16b4d9
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 6 deletions.
diff --git a/.vale.ini b/.vale.ini
@@ -3,6 +3,7 @@ Packages = Google, https://github.com/jdbaldry/Hugo/releases/download/v0.2.0-rc.
 StylesPath = vale
 [*.md]
 BasedOnStyles = Google, Grafana
+Google.Headings = NO
 Google.Quotes = NO
 Google.Units = NO
 Google.WordList = NO

diff --git a/docs/make-docs b/docs/make-docs
@@ -275,7 +275,7 @@ PATHS_mimir='docs/sources/mimir'
 PATHS_plugins_grafana_jira_datasource='docs/sources'
 PATHS_plugins_grafana_mongodb_datasource='docs/sources'
 PATHS_plugins_grafana_splunk_datasource='docs/sources'
-Paths_tempo='docs/sources/tempo'
+PATHS_tempo='docs/sources/tempo'
 PATHS_website='content'
 
 # identifier STR

diff --git a/docs/sources/write/markdown-guide/index.md b/docs/sources/write/markdown-guide/index.md
@@ -160,8 +160,32 @@ Use repetitive list numbering, to avoid inconsistent list numbering:
 The preceding list displays as:
 
 1. First
-2. Second
-3. Third
+1. Second
+1. Third
+
+When writing paragraphs as list entries, you must use proper indentation.
+Each line in the entry must have three spaces before the first word.
+Each new paragraph must have an empty line before it.
+
+For example:
+
+```markdown
+1. First paragraph in first entry.
+   Second sentence in first paragraph.
+
+   Second paragraph in first entry.
+
+1. First paragraph in second entry.
+```
+
+The example displays as follows:
+
+1. First paragraph in first entry.
+   Second sentence in first paragraph.
+
+   Second paragraph in first entry.
+
+1. First paragraph in second entry.
 
 ## Unordered lists
 

diff --git a/docs/sources/write/style-guide/capitalization-punctuation/index.md b/docs/sources/write/style-guide/capitalization-punctuation/index.md
@@ -32,6 +32,8 @@ Use all-caps capitalization exclusively for abbreviations, such as `API`, `HTTP`
 
 The names of people, places, and products take initial capitals because they are proper nouns.
 
+If you're not sure of whether something is a product or not, consult the product manager, or if there isn't one, the responsible squad.
+
 ### Grafana-specific capitalization guidelines
 
 - Menu and submenu titles always use sentence case: capitalize the first word, and lowercase the rest.

diff --git a/docs/sources/write/style-guide/ux-writing/index.md b/docs/sources/write/style-guide/ux-writing/index.md
@@ -85,6 +85,10 @@ Use active voice to make clear who is performing the action.
 
 Capitalize only the first word in the title, the first word in a subheading after a colon, and any proper nouns (people, places, products).
 
+{{% admonition %}}
+If you're not sure of whether something is a product or not, consult the product manager, or if there isn't one, the responsible squad.
+{{% /admonition %}}
+
 **Use:**
 
 > Create and manage dashboards to visualize your data.

diff --git a/vale/.vale.ini b/vale/.vale.ini
@@ -3,6 +3,7 @@ Packages = https://github.com/jdbaldry/Hugo/releases/download/v0.2.0-rc.1/Hugo.z
 StylesPath = /etc/vale/styles
 [*.md]
 BasedOnStyles = Google, Grafana
+Google.Headings = NO
 Google.Quotes = NO
 Google.Units = NO
 Google.WordList = NO

diff --git a/vale/.vale.jsonnet b/vale/.vale.jsonnet
@@ -10,8 +10,9 @@
       '*.md': {
         BasedOnStyles: 'Google, Grafana',
 
-        // More often than not, we need to be consistent with Prometheus units or units used Grafana UI which are not represented in the form encouraged by SI.
+        'Google.Headings': 'NO',
         'Google.Quotes': 'NO',
+        // More often than not, we need to be consistent with Prometheus units or units used Grafana UI which are not represented in the form encouraged by SI.
         'Google.Units': 'NO',
         'Google.WordList': 'NO',
 

diff --git a/vale/Google/Headings.yml b/vale/Google/Headings.yml
@@ -9,7 +9,6 @@ indicators:
 exceptions:
   - Azure
   - CLI
-  - Code
   - Cosmos
   - Docker
   - Emmet

diff --git a/vale/dictionaries/en_US-grafana.dic b/vale/dictionaries/en_US-grafana.dic
@@ -1,5 +1,7 @@
-29
+32
 API/S po:noun
+Datadog/ po:noun
+ESLint/ po:noun
 Goldmark/ po:noun
 Grafana/M po:noun
 OnCall/ po:noun
@@ -11,6 +13,7 @@ SLO/S po:noun
 Splunk/ po:noun
 UI/S po:noun
 URI/S po:noun
+Webpack/ po:noun
 allowlist/S po:noun
 backport/DGS po:verb
 blockquote/S po:noun

diff --git a/vale/dictionaries/wordlist b/vale/dictionaries/wordlist
@@ -1,4 +1,6 @@
 API/S po:noun
+Datadog/ po:noun
+ESLint/ po:noun
 Goldmark/ po:noun
 Grafana/M po:noun
 OnCall/ po:noun
@@ -10,6 +12,7 @@ SLO/S po:noun
 Splunk/ po:noun
 UI/S po:noun
 URI/S po:noun
+Webpack/ po:noun
 allowlist/S po:noun
 backport/DGS po:verb
 blockquote/S po:noun
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,6 @@ indicators: @@
     exceptions:
       - Azure
       - CLI
-      - Code
       - Cosmos
       - Docker
       - Emmet
@@ Expand Down @@