Skip to content

Commit 54a1867

Browse files
tothmanotothmano
authored
Change nav items from title case to sentence case (#132)
1 parent b382eac commit 54a1867

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+66
-88
lines changed

‎.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ We encourage you to participate in this documentation project. We appreciate you
44

55
To contribute, fork this repo, and then clone it. For more information, see the [GitHub documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
66

7-
Before contributing, please read the following guidelines and the [code of conduct](/.github/CODE_OF_CONDUCT.md).
7+
Before contributing, please read the following guidelines and the [Code of conduct](/.github/CODE_OF_CONDUCT.md).
88

99
## Submit an issue
1010

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ We value your input and invite you to help us make the Axiom documentation even
6161
1. Rate pages. Hit the 👍/👎 button on any page to let us know what you like and what you don’t.
6262
2. Leave feedback. Click **Raise issue** on any documentation page to create a GitHub issue where you can share thoughts and suggestions.
6363
3. Suggest edits. Found a typo or outdated information? Click **Suggest edits** directly on the page.
64-
4. Contribute content. If you have in-depth knowledge or unique use cases, we encourage you to contribute by writing new sections or enhancing existing ones. Before contributing, please read the [contribution guidelines](/.github/CONTRIBUTING.md) and the [code of conduct](/.github/CODE_OF_CONDUCT.md).
64+
4. Contribute content. If you have in-depth knowledge or unique use cases, we encourage you to contribute by writing new sections or enhancing existing ones. Before contributing, please read the [Contribution guidelines](/.github/CONTRIBUTING.md) and the [Code of conduct](/.github/CODE_OF_CONDUCT.md).
6565
6666
## Troubleshooting
6767

‎apl/data-types/null-values.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Null values'
33
description: 'This page explains how APL represents missing values.'
4-
sidebarTitle: Null Values
54
tags: ['axiom documentation', 'documentation', 'axiom', 'scalar', 'null', 'datetime', 'dynamic', 'guid', 'int']
65
---
76

‎apl/data-types/scalar-data-types.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Scalar data types'
33
description: 'This page explains the data types in APL.'
4-
sidebarTitle: Scalar Data Types
54
tags: ['axiom documentation', 'documentation', 'axiom', 'scalar', 'data types', 'bool', 'datetime', 'dynamic', 'int', 'long', 'string', 'timespan']
65
---
76

‎apl/entities/entity-names.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Entity names'
33
description: 'This page explains how to use entity names in your APL query.'
4-
sidebarTitle: Entity Names
54
tags: ['axiom documentation', 'documentation', 'axiom', 'scalar', 'columns', 'identifier', 'entity names', 'identifier quoting']
65
---
76

‎apl/introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ tags: ['axiom documentation', 'documentation', 'axiom', 'APL', 'axiom processing
1010

1111
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.
1212

13-
## Getting Started
13+
## Get started
1414

1515
Go to the Explore tab and click one of your datasets to get started. The APL editor has full auto-completion so you can poke around or you can get a better understanding of all the features by using the reference menu to the left of this page.
1616

‎apl/query-statement/set-statement.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Set statement'
33
description: 'The set statement is used to set a query option in your APL query.'
4-
sidebarTitle: Set Statement
54
tags: ['axiom documentation', 'documentation', 'axiom', 'set statement', 'strict types']
65
---
76

‎apl/reference/special-field-attributes.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Special field attributes'
33
description: 'This page explains how to implement special fields within APL queries to enhance the functionality and interactivity of datasets. Use these fields in APL queries to add unique behaviors to the Axiom user interface.'
4-
sidebarTitle: 'Special Field Attributes'
54
tags: ['axiom documentation', 'documentation', 'axiom', 'APL', 'tutorial', 'apl overview', 'row attributes hints', 'column attributes hints', 'fieldname unit', 'row url', 'row status', 'row description', 'col tooltip', 'col heatmap', 'data visualization', 'user interface']
65
---
76

‎apl/scalar-functions/ip-functions.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: IP functions
33
description: 'Learn how to use and combine different ip functions in APL'
4-
sidebarTitle: IP Functions
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'format ipv4', 'parse_ipv4', 'ipv4', 'ipv4 is private', 'netmask', 'suffix']
76
---

‎apl/tutorial.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Sample queries'
33
description: "Explore how to use APL in Axiom’s Explore tab to run queries using Tabular Operators, Scalar Functions, and Aggregation Functions."
4-
sidebarTitle: Sample Queries
54
icon: vial
65
tags: ['axiom documentation', 'documentation', 'axiom', 'APL', 'tutorial', 'apl overview', 'tabular operators', 'scalar functions', 'aggregation functions']
76
---

‎dashboard-elements/log-stream.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Log stream'
33
description: 'This section explains how to create log stream dashboard elements and add them to your dashboard.'
4-
sidebarTitle: Log Stream
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
76
---

‎dashboard-elements/monitor-list.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Monitor list
33
description: 'This section explains how to create monitor list dashboard elements and add them to your dashboard.'
4-
sidebarTitle: Monitor List
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
76
---

‎dashboard-elements/pie-chart.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Pie chart'
33
description: 'This section explains how to create pie chart dashboard elements and add them to your dashboard.'
4-
sidebarTitle: Pie Chart
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
76
---

‎dashboard-elements/scatter-plot.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Scatter plot'
33
description: 'This section explains how to create scatter plot dashboard elements and add them to your dashboard.'
4-
sidebarTitle: Scatter Plot
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
76
---

‎dashboard-elements/time-series.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Time series'
33
description: 'This section explains how to create time series dashboard elements and add them to your dashboard.'
4-
sidebarTitle: Time Series
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
76
---

‎getting-started-guide/getting-started.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Get started'
33
description: 'This guide introduces you to the concepts behind working with Axiom and give a short introduction to each of the high-level features.'
4-
sidebarTitle: Get Started
54
icon: rocket
65
tags:
76
['axiom documentation', 'documentation', 'axiom', 'stream data', 'analyze data', 'explore data']

‎guides/opentelemetry-django.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Send OpenTelemetry data from a Django app to Axiom'
33
description: 'This guide explains how to send OpenTelemetry data from a Django app to Axiom using the Python OpenTelemetry SDK.'
44
overview: 'Django framework with OpenTelemetry integration'
5-
sidebarTitle: Django Using OTel
5+
sidebarTitle: Django using OTel
66
tags: ['guides', 'django', 'otel', 'opentelemetry', 'python']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-dotnet.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'OpenTelemetry using .NET'
33
description: 'This guide explains how to configure a .NET app using the .NET OpenTelemetry SDK to send telemetry data to Axiom.'
44
overview: '.NET with OpenTelemetry for enhanced observability'
5-
sidebarTitle: .NET Using OTel
5+
sidebarTitle: .NET using OTel
66
tags: ['guides', '.NET', 'dotnet', 'OpenTelemetry', 'otel']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-go.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'OpenTelemetry using Golang'
33
description: 'This guide explains how to configure a Go app using the Go OpenTelemetry SDK to send telemetry data to Axiom.'
44
overview: 'Go language with OpenTelemetry for distributed tracing'
5-
sidebarTitle: Golang Using OTel
5+
sidebarTitle: Golang using OTel
66
tags: ['guides', 'golang', 'go', 'otel', 'opentelemetry']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-java.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Send data from Java app using OpenTelemetry'
33
description: 'This page explains how to configure a Java app using the Java OpenTelemetry SDK to send telemetry data to Axiom.'
44
overview: 'Java with OpenTelemetry for comprehensive telemetry data'
5-
sidebarTitle: Java Using OTel
5+
sidebarTitle: Java using OTel
66
tags: ['guides', 'java', 'opentelemetry', 'otel']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-nextjs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'OpenTelemetry using Next.js'
33
description: 'This guide demonstrates how to configure OpenTelemetry in a Next.js app to send telemetry data to Axiom.'
44
overview: 'Next.js with OpenTelemetry for full-stack tracing'
5-
sidebarTitle: Next.js Using OTel
5+
sidebarTitle: Next.js using OTel
66
tags: ['guides', 'nextjs', 'opentelemetry', 'otel']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-nodejs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'OpenTelemetry using Node.js'
33
description: 'This guide demonstrates how to configure OpenTelemetry in a Node.js app to send telemetry data to Axiom.'
44
overview: 'Node.js runtime with OpenTelemetry integration'
5-
sidebarTitle: Node.js Using OTel
5+
sidebarTitle: Node.js using OTel
66
tags: ['guides', 'nodejs', 'typescript', 'javascript', 'js', 'ts', 'otel', 'opentelemetry', 'node.js']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-python.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Send OpenTelemetry data from a Python app to Axiom'
33
description: 'This guide explains how to send OpenTelemetry data from a Python app to Axiom using the Python OpenTelemetry SDK.'
44
overview: 'Python with OpenTelemetry for distributed tracing'
5-
sidebarTitle: Python Using OTel
5+
sidebarTitle: Python using OTel
66
tags: ['guides', 'python', 'py', 'opentelemetry', 'otel']
77
logoId: 'openTelemetry'
88
---

‎guides/opentelemetry-ruby.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Send OpenTelemetry data from a Ruby on Rails app to Axiom'
33
description: 'This guide explains how to send OpenTelemetry data from a Ruby on Rails App to Axiom using the Ruby OpenTelemetry SDK.'
44
overview: 'Rails framework with OpenTelemetry integration'
5-
sidebarTitle: Ruby on Rails Using OTel
5+
sidebarTitle: Ruby on Rails using OTel
66
tags: ['guides', 'ruby', 'ruby on rails', 'otel', 'opentelemetry']
77
logoId: 'openTelemetry'
88
---

‎introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ tags:
1818
<img src="/doc-assets/intro.png" alt="Axiom user interface" />
1919
</Frame>
2020

21-
To dive right in, read the [Getting Started Guide](/getting-started-guide/getting-started).
21+
To dive right in, read the [Get started guide](/getting-started-guide/getting-started).
2222

2323
The Axiom documentation enables you 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. See below for a list of the most common use cases.
2424

‎mint.json

+20-20
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@
3636
},
3737
"tabs": [
3838
{
39-
"name": "Apps and Integrations",
39+
"name": "Apps and integrations",
4040
"url": "apps"
4141
},
4242
{
43-
"name": "Query Reference",
43+
"name": "Query reference",
4444
"url": "apl"
4545
},
4646
{
47-
"name": "API Reference",
47+
"name": "API reference",
4848
"url": "restapi"
4949
}
5050
],
@@ -63,7 +63,7 @@
6363
"url": "https://axiom.co/changelog"
6464
},
6565
{
66-
"name": "Book a Demo",
66+
"name": "Book a demo",
6767
"icon": "calendar",
6868
"url": "https://axiom.co/demo"
6969
}
@@ -78,7 +78,7 @@
7878
]
7979
},
8080
{
81-
"group": "Send Data to Axiom",
81+
"group": "Send data to Axiom",
8282
"pages": [
8383
"send-data/ingest",
8484
{
@@ -160,7 +160,7 @@
160160
]
161161
},
162162
{
163-
"group": "Understand Data",
163+
"group": "Understand data",
164164
"pages": [
165165
{
166166
"group": "Query",
@@ -185,7 +185,7 @@
185185
]
186186
},
187187
{
188-
"group": "Dashboard Elements",
188+
"group": "Dashboard elements",
189189
"icon": "sparkles",
190190
"pages": [
191191
"dashboard-elements/overview",
@@ -214,7 +214,7 @@
214214
]
215215
},
216216
{
217-
"group": "Process Data",
217+
"group": "Process data",
218218
"pages": [
219219
{
220220
"group": "Flow",
@@ -240,10 +240,10 @@
240240
]
241241
},
242242
{
243-
"group": "Management and Billing",
243+
"group": "Management and billing",
244244
"pages": [
245245
{
246-
"group": "Data Management",
246+
"group": "Data management",
247247
"icon": "database",
248248
"pages": [
249249
"reference/introduction",
@@ -281,7 +281,7 @@
281281
]
282282
},
283283
{
284-
"group": "Get Started",
284+
"group": "Get started",
285285
"pages": [
286286
"apl/introduction",
287287
"apl/tutorial"
@@ -291,7 +291,7 @@
291291
"group": "Functions",
292292
"pages": [
293293
{
294-
"group": "Scalar Functions",
294+
"group": "Scalar functions",
295295
"icon": "calendar-days",
296296
"pages": [
297297
"apl/scalar-functions/array-functions",
@@ -308,7 +308,7 @@
308308
]
309309
},
310310
{
311-
"group": "Aggregation Functions",
311+
"group": "Aggregation functions",
312312
"icon": "sigma",
313313
"pages": [
314314
"apl/aggregation-function/statistical-functions",
@@ -344,7 +344,7 @@
344344
"group": "Operators",
345345
"pages": [
346346
{
347-
"group": "Tabular Operators",
347+
"group": "Tabular operators",
348348
"icon": "table",
349349
"pages": [
350350
"apl/tabular-operators/overview",
@@ -370,7 +370,7 @@
370370
]
371371
},
372372
{
373-
"group": "Scalar Operators",
373+
"group": "Scalar operators",
374374
"icon": "binary",
375375
"pages": [
376376
"apl/scalar-operators/logical-operators",
@@ -411,7 +411,7 @@
411411
]
412412
},
413413
{
414-
"group": "Get Started",
414+
"group": "Get started",
415415
"pages": [
416416
"restapi/introduction",
417417
"restapi/ingest",
@@ -421,13 +421,13 @@
421421
]
422422
},
423423
{
424-
"group": "User Endpoints",
424+
"group": "User endpoints",
425425
"pages": [
426426
"restapi/endpoints/getCurrentUser"
427427
]
428428
},
429429
{
430-
"group": "Dataset Endpoints",
430+
"group": "Dataset endpoints",
431431
"pages": [
432432
"restapi/endpoints/getDatasets",
433433
"restapi/endpoints/getDataset",
@@ -441,7 +441,7 @@
441441
]
442442
},
443443
{
444-
"group": "Annotation Endpoints",
444+
"group": "Annotation endpoints",
445445
"pages": [
446446
"restapi/endpoints/getAnnotations",
447447
"restapi/endpoints/getAnnotation",
@@ -451,7 +451,7 @@
451451
]
452452
},
453453
{
454-
"group": "API Token Endpoints",
454+
"group": "API token endpoints",
455455
"pages": [
456456
"restapi/endpoints/getTokens",
457457
"restapi/endpoints/getToken",

‎monitor-data/monitors.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Monitors and notifiers'
33
description: 'Learn how to setup monitors and notifiers to get alerts when queries match certain conditions.'
4-
sidebarTitle: Monitors and Notifiers
54
tags:
65
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'monitors', 'notifiers', 'slack', 'email', 'pagerduty', 'webhook', 'opsgenie', 'discord', 'discord webhook']
76
---

‎process-data/destinations/manage-destinations.mdx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Manage destinations'
33
description: 'This page explains how to manage Flow destinations.'
4-
sidebarTitle: 'Manage Destinations'
54
---
65

76
<Note>

0 commit comments

Comments
 (0)