From 11fddf26306192bba9698e96897d03befe926c7b Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 13:07:11 +0100 Subject: [PATCH 01/13] Update Vale for CI checks to work --- .vale.ini | 7 ++----- vale/styles/.vale-config/1-MDX.ini | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 5 deletions(-) create mode 100644 vale/styles/.vale-config/1-MDX.ini diff --git a/.vale.ini b/.vale.ini index c2e68bf8..16bab560 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,17 +4,14 @@ MinAlertLevel = suggestion Vocab = docs -Packages = Google +Packages = Google, MDX IgnoredScopes = code, tt, img, url, a SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown -[formats] -mdx = md - -[*.{md, mdx}] +[*.{md,mdx}] BasedOnStyles = Vale, Google, docs diff --git a/vale/styles/.vale-config/1-MDX.ini b/vale/styles/.vale-config/1-MDX.ini new file mode 100644 index 00000000..d1f1a54d --- /dev/null +++ b/vale/styles/.vale-config/1-MDX.ini @@ -0,0 +1,21 @@ +[formats] +mdx = md + +[*.mdx] +CommentDelimiters = {/*, */} + +# Exclude: +# +# `import ...`, `export ...` +# `` +# `...` +# `{ ... }` +TokenIgnores = (?sm)((?:import|export) .+?$), \ +(?)(?!`), \ +(<[A-Z]\w+>.+?<\/[A-Z]\w+>) + +# Exclude: +# +# `` +BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ +(?sm)^({.+.*}) From 8139024b8c123f8ad6c46098776b925a0b3d8cf6 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 13:08:57 +0100 Subject: [PATCH 02/13] Update introduction.mdx --- introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/introduction.mdx b/introduction.mdx index fbe60fd2..d9574dd7 100644 --- a/introduction.mdx +++ b/introduction.mdx @@ -1,6 +1,6 @@ --- title: "Introduction" -description: "In this documentation, you will be able to gain a deeper understanding of what Axiom is, how to get it installed, and how best to use it for your organization’s use case." +description: "In this documentation, you gain a deeper understanding of what Axiom is, how to get it installed, and how best to use it for your organization’s use case." icon: hand-wave tags: [ From 4b8a383a66d83a86543ea753cb26057de782ba51 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 14:31:27 +0100 Subject: [PATCH 03/13] Update to fix errors --- apl/introduction.mdx | 16 ++++++++-------- apps/introduction.mdx | 24 ++++++++++++------------ vale/styles/docs/bold.yml | 8 -------- 3 files changed, 20 insertions(+), 28 deletions(-) delete mode 100644 vale/styles/docs/bold.yml diff --git a/apl/introduction.mdx b/apl/introduction.mdx index 76afe845..6b2530e5 100644 --- a/apl/introduction.mdx +++ b/apl/introduction.mdx @@ -1,14 +1,14 @@ --- -title: 'Axiom Processing Language (APL)' -description: 'This section explains how to use the Axiom Processing Language to get deeper insights from your data.' +title: "Axiom Processing Language (APL)" +description: "This section explains how to use the Axiom Processing Language to get deeper insights from your data." sidebarTitle: Introduction icon: door-open -tags: ['axiom documentation', 'documentation', 'axiom', 'APL', 'axiom processing language', 'data explorer', 'getiing started guide', 'summarize', 'filter'] +tags: ["axiom documentation", "documentation", "axiom", "APL", "axiom processing language", "data explorer", "getiing started guide", "summarize", "filter"] --- ## Introduction -The Axiom Processing Language (APL) is a query language that is perfect for getting deeper insights from your data. Whether logs, events, analytics, or similar, APL provides the flexibility to filter, manipulate, and summarize your data exactly the way you need it. +The Axiom Processing Language (APL) is a query language that’s perfect for getting deeper insights from your data. Whether logs, events, analytics, or similar, APL provides the flexibility to filter, manipulate, and summarize your data exactly the way you need it. ## Get started @@ -29,7 +29,7 @@ DataSource Where: - DataSource is the name of the dataset you want to query -- Operator is a function that will be applied to the data +- Operator is a function that’s applied to the data Let’s look at an example query. @@ -40,11 +40,11 @@ Let’s look at an example query. | summarize count() by bin_auto(_time), actor ``` -The query above begins with reference to a dataset called **github-issue-comment-event** and contains several operators, [extend](/apl/tabular-operators/extend-operator), [where](/apl/tabular-operators/where-operator), and [summarize](/apl/tabular-operators/summarize-operator), each separated by a `pipe`. The extend operator creates the **bot** column in the returned result, and sets its values depending on the value of the actor column, the **where** operator filters out the value of the **bot** to a branch of rows and then produce a chart from the aggregation using the **summarize** operator. +The query above begins with reference to a dataset called **github-issue-comment-event** and contains several operators, [extend](/apl/tabular-operators/extend-operator), [where](/apl/tabular-operators/where-operator), and [summarize](/apl/tabular-operators/summarize-operator), each separated by a `pipe`. The extend operator creates the **bot** field in the returned result, and sets its values depending on the value of the actor field, the **where** operator filters out the value of the **bot** to a branch of rows and then produce a chart from the aggregation using the **summarize** operator. The most common kind of query statement is a tabular expression statement. Tabular statements contain operators, each of which starts with a tabular `input` and returns a tabular `output.` -- Explore the [tabular operators](/apl/tabular-operators/extend-operator) we support. -- Check out our [entity names and identifier naming rules](/apl/entities/entity-names). +- Explore the supported [tabular operators](/apl/tabular-operators/extend-operator). +- Check out [entity names and identifier naming rules](/apl/entities/entity-names). Axiom Processing Language supplies a set of system [data types](/apl/data-types/scalar-data-types) that define all the types of [data](/apl/data-types/null-values) that can be used with Axiom Processing Language. diff --git a/apps/introduction.mdx b/apps/introduction.mdx index dddadb20..1359dd60 100644 --- a/apps/introduction.mdx +++ b/apps/introduction.mdx @@ -1,18 +1,18 @@ --- -title: 'Apps' -description: 'Enrich your Axiom organization with dedicated apps.' -sidebarTitle: 'Overview' +title: "Apps" +description: "Enrich your Axiom organization with dedicated apps." +sidebarTitle: "Overview" tags: [ - 'axiom documentation', - 'documentation', - 'axiom', - 'aws lambda', - 'cloudflare workers', - 'datadog migration', - 'grafana', - 'vercel', - 'netlify', + "axiom documentation", + "documentation", + "axiom", + "aws lambda", + "cloudflare workers", + "datadog migration", + "grafana", + "vercel", + "netlify", ] --- diff --git a/vale/styles/docs/bold.yml b/vale/styles/docs/bold.yml deleted file mode 100644 index 297d906b..00000000 --- a/vale/styles/docs/bold.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Only use bold for UI elements." -link: 'https://developers.google.com/style/ui-elements' -nonword: true -level: suggestion -scope: raw -tokens: - - '\*\*.+\*\*' \ No newline at end of file From a637dcbeecaecd9090ae9706a8f3466239473468 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 14:38:21 +0100 Subject: [PATCH 04/13] Update configure.mdx --- dashboard-elements/configure.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dashboard-elements/configure.mdx b/dashboard-elements/configure.mdx index ca7b5419..9521179d 100644 --- a/dashboard-elements/configure.mdx +++ b/dashboard-elements/configure.mdx @@ -1,5 +1,5 @@ --- -title: 'Configure dashboard elements' +title: "Configure dashboard elements" description: 'This section explains how to configure dashboard elements.' sidebarTitle: Configure tags: From 85d36fa3d7f3c3d934d15e7f0021ae36dac3b89c Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 16:34:59 +0100 Subject: [PATCH 05/13] Update .vale.ini --- .vale.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale.ini b/.vale.ini index 16bab560..03b66f48 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,6 +13,7 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] + BasedOnStyles = Vale, Google, docs # For now, ignore rules because they give too many false positives From a144ce3200be2a997a72565fb5c2c4a7ea8ab503 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 16:37:56 +0100 Subject: [PATCH 06/13] Update .vale.ini --- .vale.ini | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 03b66f48..16bab560 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,7 +13,6 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] - BasedOnStyles = Vale, Google, docs # For now, ignore rules because they give too many false positives From 277867d6d2b6be65a6808a36155123873c73fb9b Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 16:38:15 +0100 Subject: [PATCH 07/13] Update .vale.ini --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 16bab560..7bace0e3 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,7 +13,7 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] -BasedOnStyles = Vale, Google, docs +BasedOnStyles = Vale, Google # For now, ignore rules because they give too many false positives Google.Passive = NO From d529cb82b636bc3a7d75f442271bb5d65aaeae92 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 16:41:13 +0100 Subject: [PATCH 08/13] Update reject.txt --- vale/styles/config/vocabularies/docs/reject.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/vale/styles/config/vocabularies/docs/reject.txt b/vale/styles/config/vocabularies/docs/reject.txt index 61baa830..784cb7d6 100644 --- a/vale/styles/config/vocabularies/docs/reject.txt +++ b/vale/styles/config/vocabularies/docs/reject.txt @@ -1,2 +1 @@ -axiom HoneyComb \ No newline at end of file From 34ffff74ccde64e1b6227b42bfdf5fb1e9eee8da Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 16:45:38 +0100 Subject: [PATCH 09/13] Update --- .vale.ini | 2 +- vale/styles/config/vocabularies/docs/accept.txt | 4 ++-- vale/styles/docs/curly-quotation-marks.yml | 11 ----------- 3 files changed, 3 insertions(+), 14 deletions(-) delete mode 100644 vale/styles/docs/curly-quotation-marks.yml diff --git a/.vale.ini b/.vale.ini index 7bace0e3..16bab560 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,7 +13,7 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] -BasedOnStyles = Vale, Google +BasedOnStyles = Vale, Google, docs # For now, ignore rules because they give too many false positives Google.Passive = NO diff --git a/vale/styles/config/vocabularies/docs/accept.txt b/vale/styles/config/vocabularies/docs/accept.txt index 5fb9295c..12e65d0e 100644 --- a/vale/styles/config/vocabularies/docs/accept.txt +++ b/vale/styles/config/vocabularies/docs/accept.txt @@ -4,7 +4,7 @@ Logstash Filebeat Metricbeat Fluentd -Syslog +[Ss]yslog Vercel Netlify Grafana @@ -14,7 +14,6 @@ Axiom Winlogbeat Cribl LogStream -Syslog Auditbeat Auditd Packetbeat @@ -32,6 +31,7 @@ Tailscale tailnet Firehose +[Aa]xiom [Dd]isable [Cc]heck [Oo]pen-source diff --git a/vale/styles/docs/curly-quotation-marks.yml b/vale/styles/docs/curly-quotation-marks.yml deleted file mode 100644 index ab7ab781..00000000 --- a/vale/styles/docs/curly-quotation-marks.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Use curly quotations marks in text." -nonword: true -level: error -scope: raw -tokens: - - "'s" - - "n't" - - "'re" - - "'ll" - - "'ve" \ No newline at end of file From c04007877fbb4312fdf313f4023fcb65f7f7884d Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 17:02:08 +0100 Subject: [PATCH 10/13] Update .vale.ini --- .vale.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale.ini b/.vale.ini index 16bab560..03b66f48 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,6 +13,7 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] + BasedOnStyles = Vale, Google, docs # For now, ignore rules because they give too many false positives From 4701cddd27e14bebc43c778ccf7325dfee9747dc Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 17:03:36 +0100 Subject: [PATCH 11/13] Update .vale.ini --- .vale.ini | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 03b66f48..16bab560 100644 --- a/.vale.ini +++ b/.vale.ini @@ -13,7 +13,6 @@ SkippedScopes = script, style, pre, figure, code # Treat MDX as Markdown [*.{md,mdx}] - BasedOnStyles = Vale, Google, docs # For now, ignore rules because they give too many false positives From af6b25f666b7eebd6e0be6e559326b05556d20cc Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Mon, 10 Feb 2025 17:54:55 +0100 Subject: [PATCH 12/13] Updates --- .vale.ini | 5 +++-- vale/styles/docs/capitalization.yml | 16 ---------------- 2 files changed, 3 insertions(+), 18 deletions(-) delete mode 100644 vale/styles/docs/capitalization.yml diff --git a/.vale.ini b/.vale.ini index 16bab560..0a8f03fd 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ Vocab = docs Packages = Google, MDX -IgnoredScopes = code, tt, img, url, a +IgnoredScopes = code, tt, img, url, a, link, blockquote SkippedScopes = script, style, pre, figure, code @@ -22,4 +22,5 @@ Google.Headings = NO Google.Parens = NO # Ignore code surrounded by backticks or plus sign, parameters defaults, URLs, and angle brackets. -# TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) \ No newline at end of file +TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (```[a-z]*[\s\S]*?\n```) +BlockIgnores = ```[a-z]*[\s\S]*?\n``` \ No newline at end of file diff --git a/vale/styles/docs/capitalization.yml b/vale/styles/docs/capitalization.yml deleted file mode 100644 index 7f28d7a0..00000000 --- a/vale/styles/docs/capitalization.yml +++ /dev/null @@ -1,16 +0,0 @@ -extends: substitution -message: "Pay attention to capitalization. Consider using '%s' instead of '%s'." -ignorecase: false -level: warning -scope: raw -action: - name: replace -swap: - (?:\w+) Dataset: dataset - (?:\w+) Distribution: distribution - (?:\w+) Domain: domain - (?:\w+) Destination: destination - (?:\w+) Data: data - (?:\w+) Dashboard: dashboard - (?:\w+) Virtual Fields: virtual fields - (?:\w+) Starred queries: starred queries \ No newline at end of file From 02fd5e96d34af9a659c5d6907467ef92fc1d2399 Mon Sep 17 00:00:00 2001 From: Mano Toth Date: Wed, 12 Feb 2025 12:20:10 +0100 Subject: [PATCH 13/13] Update tremor.mdx --- send-data/tremor.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/send-data/tremor.mdx b/send-data/tremor.mdx index 09eb6970..7ff2df12 100644 --- a/send-data/tremor.mdx +++ b/send-data/tremor.mdx @@ -1,6 +1,6 @@ --- title: 'Send data from Tremor to Axiom' -description: 'This step-by-step guide will help you configure Tremor connectors and events components to interact with your databases, APIs, and ingest data from these sources into Axiom.' +description: 'This step-by-step guide helps you configure Tremor connectors and events components to interact with your databases, APIs, and ingest data from these sources into Axiom.' overview: 'Event processing system for unstructured data' sidebarTitle: Tremor tags: