Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Vale for CI checks to work #208

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
12 changes: 5 additions & 7 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@ MinAlertLevel = suggestion

Vocab = docs

Packages = Google
Packages = Google, MDX

IgnoredScopes = code, tt, img, url, a
IgnoredScopes = code, tt, img, url, a, link, blockquote

SkippedScopes = script, style, pre, figure, code

# Treat MDX as Markdown
[formats]
mdx = md

[*.{md, mdx}]
[*.{md,mdx}]

BasedOnStyles = Vale, Google, docs

Expand All @@ -25,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]+\[)
TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (```[a-z]*[\s\S]*?\n```)
BlockIgnores = ```[a-z]*[\s\S]*?\n```
16 changes: 8 additions & 8 deletions apl/introduction.mdx
Original file line number Diff line number Diff line change
@@ -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"]

Check warning on line 6 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L6

Use curly quotations marks in text.
---

## 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.

Check warning on line 11 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L11

Use 'that's' instead of 'that is'.

## Get started

Expand All @@ -29,7 +29,7 @@
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

Check warning on line 32 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L32

Avoid using 'will'.

Let’s look at an example query.

Expand All @@ -40,11 +40,11 @@
| 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.

Check warning on line 43 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L43

Only use bold for UI elements.

Check warning on line 43 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L43

Consider using 'field' instead of 'column'.

Check warning on line 43 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L43

Consider using 'field' instead of 'column'.

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 warning on line 47 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L47

Try to avoid using first-person plural like 'we'.
- Check out [entity names and identifier naming rules](/apl/entities/entity-names).

Check warning on line 48 in apl/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apl/introduction.mdx#L48

Try to avoid using first-person plural like 'our'.

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.
24 changes: 12 additions & 12 deletions apps/introduction.mdx
Original file line number Diff line number Diff line change
@@ -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",

Check warning on line 14 in apps/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

apps/introduction.mdx#L14

Use curly quotations marks in text.
"netlify",
]
---

Expand Down
2 changes: 1 addition & 1 deletion dashboard-elements/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'Configure dashboard elements'
title: "Configure dashboard elements"
description: 'This section explains how to configure dashboard elements.'
sidebarTitle: Configure
tags:
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']

Check warning on line 6 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L6

Use curly quotations marks in text.
---

When you create a chart, click <img src="/doc-assets/icons/options.svg" className="inline-icon" alt="View options icon" /> to access the following options.
Expand All @@ -12,28 +12,28 @@

Specify how to treat missing or undefined values:

- **Auto:** This option automatically decides the best way to represent missing or undefined values in the data series based on the chart type and the rest of the data.

Check warning on line 15 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L15

Only use bold for UI elements.
- **Ignore:** This option ignores any missing or undefined values in the data series. This means that the chart only displays the known, defined values.

Check warning on line 16 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L16

Only use bold for UI elements.
- **Join adjacent values:** This option connects adjacent data points in the data series, effectively filling in any gaps caused by missing values. The benefit of joining adjacent values is that it can provide a smoother, more continuous visualization of your data.

Check warning on line 17 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L17

Only use bold for UI elements.
- **Fill with zeros:** This option replaces any missing or undefined values in the data series with zero. This can be useful if you want to emphasize that the data is missing or undefined, as it causes a drop to zero in your chart.

Check warning on line 18 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L18

Only use bold for UI elements.

## Variant

Specify the chart type.

**Area:** An area chart displays the area between the data line and the axes, often filled with a color or pattern. Stacked charts provide the capability to design and implement intricate query dashboards while integrating advanced visualizations, enriching your logging experience over time.

Check warning on line 24 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L24

Only use bold for UI elements.

Check warning on line 24 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L24

': A' should be in lowercase.

<Frame>
<img src="/doc-assets/shots/area-variant-section-chart.png" alt="Area chart" />
</Frame>

**Bars:** A bar chart represents data in rectangular bars. The length of each bar is proportional to the value it represents. Bar charts can be used to compare discrete quantities, or when you have categorical data.

Check warning on line 30 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L30

Only use bold for UI elements.

Check warning on line 30 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L30

': A' should be in lowercase.

<Frame>
<img src="/doc-assets/shots/bar-variant-chart-1.png" alt="Bar chart" />
</Frame>

**Line:** A line chart connects individual data points into a continuous line, which is useful for showing logs over time. Line charts are often used for time series data.

Check warning on line 36 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L36

': A' should be in lowercase.

Check warning on line 36 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L36

Only use bold for UI elements.

<Frame>
<img src="/doc-assets/shots/line-variant-section-chart.png" alt="Line chart" />
Expand All @@ -43,13 +43,13 @@

Specify the scale of the vertical axis.

**Linear:** A linear scale maintains a consistent scale where equal distances represent equal changes in value. This is the most common scale type and is useful for most types of data.

Check warning on line 46 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L46

': A' should be in lowercase.

Check warning on line 46 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L46

Only use bold for UI elements.

<Frame>
<img src="/doc-assets/shots/linear-scale-y-axis-chart.png" alt="Linear scale" />
</Frame>

**Log:** A logarithmic (or log) scale represents values in terms of their order of magnitude. Each unit of distance on a log scale represents a tenfold increase in value. Log scales make it easy to see backend errors and compare values across a wide range.

Check warning on line 52 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L52

': A' should be in lowercase.

Check warning on line 52 in dashboard-elements/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

dashboard-elements/configure.mdx#L52

Only use bold for UI elements.

<Frame>
<img src="/doc-assets/shots/log-scale-y-axis-chart.png" alt="Log scale" />
Expand Down
2 changes: 1 addition & 1 deletion introduction.mdx
Original file line number Diff line number Diff line change
@@ -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:
[
Expand Down Expand Up @@ -53,7 +53,7 @@
</Card>
<Card
title="Create dashboards"
icon="chart-column"

Check warning on line 56 in introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

introduction.mdx#L56

Consider using 'field' instead of 'column'.
href="/dashboards"
>
Personalize custom models
Expand Down
2 changes: 1 addition & 1 deletion send-data/tremor.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
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:
['tremor', 'axiom documentation', 'documentation', 'axiom', 'guide', 'http', 'syslog', 'connectors', 'sink', 'json', 'tcp client', 'syslog forwarder', 'host port']

Check warning on line 7 in send-data/tremor.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

send-data/tremor.mdx#L7

Use curly quotations marks in text.

Check warning on line 7 in send-data/tremor.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

send-data/tremor.mdx#L7

Use curly quotations marks in text.

Check warning on line 7 in send-data/tremor.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

send-data/tremor.mdx#L7

Use curly quotations marks in text.
logoId: 'tremor'
---

Expand Down Expand Up @@ -73,7 +73,7 @@

This assumes you have set `TREMOR_PATH` in your environment pointing to `tremor-runtime/tremor-script/lib` if you are using a `src` clone then you can execute it as follows `tremor server run axiom-http.troy`

The`$DATASET_NAME` [dataset](/reference/datasets) you want to send logs to in Axiom, and the `$API_TOKEN` is your [Axiom API token](/reference/tokens) for ingesting and quering your Tremor logs.

Check warning on line 76 in send-data/tremor.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

send-data/tremor.mdx#L76

Did you really mean 'quering'?

## Configuration using Syslog

Expand Down
21 changes: 21 additions & 0 deletions vale/styles/.vale-config/1-MDX.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

# Exclude:
#
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
# `{ ... }`
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclude:
#
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
4 changes: 2 additions & 2 deletions vale/styles/config/vocabularies/docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Logstash
Filebeat
Metricbeat
Fluentd
Syslog
[Ss]yslog
Vercel
Netlify
Grafana
Expand All @@ -14,7 +14,6 @@ Axiom
Winlogbeat
Cribl
LogStream
Syslog
Auditbeat
Auditd
Packetbeat
Expand All @@ -32,6 +31,7 @@ Tailscale
tailnet
Firehose

[Aa]xiom
[Dd]isable
[Cc]heck
[Oo]pen-source
Expand Down
1 change: 0 additions & 1 deletion vale/styles/config/vocabularies/docs/reject.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
axiom
HoneyComb
8 changes: 0 additions & 8 deletions vale/styles/docs/bold.yml

This file was deleted.

16 changes: 0 additions & 16 deletions vale/styles/docs/capitalization.yml

This file was deleted.

11 changes: 0 additions & 11 deletions vale/styles/docs/curly-quotation-marks.yml

This file was deleted.

Loading