Skip to content

Commit fd211e9

Browse files
committed
Add overview pages, reduce number of new pages
1 parent ea25a11 commit fd211e9

9 files changed

+96
-141
lines changed

docs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@
2323
"group": "Try out Axiom",
2424
"icon": "play",
2525
"pages": [
26+
"getting-started-guide/try-out-axiom",
2627
"getting-started-guide/explore-axiom-playground",
2728
"getting-started-guide/quickstart-using-sample-data",
28-
"getting-started-guide/integrate-axiom",
29-
"getting-started-guide/get-started-example-app",
30-
"getting-started-guide/example-projects"
29+
"getting-started-guide/get-started-example-app"
3130
]
3231
},
3332
{
3433
"group": "Learn about Axiom",
3534
"icon": "book-font",
3635
"pages": [
36+
"getting-started-guide/learn-about-axiom",
3737
"getting-started-guide/event-data",
3838
"getting-started-guide/observability",
3939
"getting-started-guide/feature-states",

getting-started-guide/example-projects.mdx

Lines changed: 0 additions & 4 deletions
This file was deleted.

getting-started-guide/explore-axiom-playground.mdx

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,8 @@ title: 'Explore Axiom Playground'
33
excerpt: 'This page explains how to try out Axiom without registration with the Axiom Playground.'
44
---
55

6-
Axiom offers access to your event data without compromises: all your data, all the time, for all possible needs. Forget about data sampling, delays, or excessive costs.
7-
86
This page explains how to try out Axiom without registration with the [Axiom Playground](https://play.axiom.co/). It walks you through an example where you run a website and you want to keep an overview of the HTTP requests to this site with Axiom.
97

10-
To try out Axiom with sample data but without integrating it into your system, see [Quickstart using sample data](getting-started-guide/quickstart-using-sample-data).
11-
12-
To start integrating Axiom into your system, see [Integrate Axiom into your system](/getting-started-guide/integrate-axiom).
13-
148
## 1. Explore sample data
159

1610
1. Go to the [Axiom Playground](https://play.axiom.co/).
@@ -65,4 +59,6 @@ You see a dashboard that displays important information about the HTTP requests
6559

6660
## What’s next
6761

68-
To try out Axiom with sample data but without integrating it into your system, see [Getting started with Axiom](/getting-started-guide/getting-started).
62+
To try out Axiom with sample data, see [Quickstart using sample data](getting-started-guide/quickstart-using-sample-data).
63+
64+
To check out Axiom with an example Node.js app, see [Get started with example app](/getting-started-guide/get-started-example-app).

getting-started-guide/get-started-example-app.mdx

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Axiom enables you to query your event data without compromises: all your data, a
77

88
This page explains how to try out Axiom with an example Node.js app that emits OpenTelemetry trace data. There are many others ways you can send data to Axiom. For a full list, see [Send data](/send-data/ingest).
99

10-
To try out Axiom without registration, go to the [Axiom Playground](https://play.axiom.co/). For more information on how to navigate the Playground, see [Explore Axiom Playground](/getting-started-guide/explore-axiom-playground).
10+
To try out Axiom without registration, see [Explore Axiom Playground](/getting-started-guide/explore-axiom-playground).
1111

12-
To connect Axiom to your system, see [Integrate Axiom into your system](/getting-started-guide/integrating-axiom).
12+
To try out Axiom with sample data, see [Quickstart using sample data](getting-started-guide/quickstart-using-sample-data).
1313

1414
## 1. Set up Axiom
1515

@@ -164,8 +164,4 @@ You created a monitor that automatically sends a notification to your email addr
164164
<video controls autoPlay muted loop>
165165
<source src="/doc-assets/videos/create-monitor.mp4" type="video/mp4">
166166
</source>
167-
</video>
168-
169-
## What's next
170-
171-
To start integrating Axiom into your system, see [Start integrating Axiom into your system](/getting-started-guide/integrate-axiom).
167+
</video>

getting-started-guide/getting-started.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ tags:
1010
<img src="/doc-assets/intro.png" alt="Axiom user interface" />
1111
</Frame>
1212

13+
Axiom enables you to make the most of your event data without compromises: all your data, all the time, for all possible needs. Say goodbye to data sampling, waiting times, and hefty fees.
14+
15+
This page explains how to start using Axiom and leverage the power of event data in your organization.
16+
1317
## 1. Send your data to Axiom
1418

1519
You can send data to Axiom in a variety of ways. Each individual piece of data is an event.
@@ -97,3 +101,10 @@ As your use of Axiom widens, customize it for your organization’s needs. For e
97101
- Create and manage API tokens.
98102

99103
<Card title="Customize your organization" icon="gear" href="/reference/settings"></Card>
104+
105+
## What’s next
106+
107+
Choose one of the following learning pathways:
108+
109+
- [Try out Axiom](/getting-started-guide/try-out-axiom) for a more hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data.
110+
- [Learn about Axiom](/getting-started-guide/learn-about-axiom) for a more educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering.

getting-started-guide/integrate-axiom.mdx

Lines changed: 0 additions & 101 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 'Learn about Axiom'
3+
excerpt: 'This section offers a conceptual understanding of Axiom and its offering.'
4+
sidebarTitle: Overview
5+
---
6+
7+
The following pages offer an educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering:
8+
9+
<Card
10+
title="Event data"
11+
href="/getting-started-guide/event-data"
12+
>
13+
Learn about the fundamentals of timestamped event data in Axiom
14+
</Card>
15+
16+
<Card
17+
title="Axiom for observability"
18+
href="/getting-started-guide/observability"
19+
>
20+
Learn about how Axiom helps you leverage timestamped event data for observability purposes
21+
</Card>
22+
23+
<Card
24+
title="Glossary"
25+
href="/getting-started-guide/glossary"
26+
>
27+
Learn about the key concepts in Axiom
28+
</Card>
29+
30+
For a more hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data, see [Try out Axiom](/getting-started-guide/try-out-axiom).

getting-started-guide/quickstart-using-sample-data.mdx

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@ title: 'Quickstart using sample data'
33
excerpt: 'This page explains how to try out Axiom with sample data.'
44
---
55

6-
Axiom enables you to query your event data without compromises: all your data, all the time, for all possible needs. No sampling, no waiting, and no extravagant bills.
7-
8-
This page explains how to try out Axiom with sample data. It walks you through an example where you run a website and you want to keep an overview of the HTTP requests to this site with Axiom.
6+
This page explains how to try out Axiom with sample data. It walks you through an example where you want to keep track of OpenTelemetry (OTel) traces with Axiom.
97

108
By following this page, you will:
119

@@ -15,55 +13,54 @@ By following this page, you will:
1513
1. Visualize the data by creating a simple dashboard.
1614
1. Set up a monitor that alerts you about internal server errors.
1715

18-
To try out Axiom without registration, go to the [Axiom Playground](https://play.axiom.co/). For more information on how to navigate the Playground, see [Try out Axiom without registration](/getting-started-guide/explore-axiom-playground).
19-
20-
To start integrating Axiom into your system, see [Integrate Axiom into your system](/getting-started-guide/integrate-axiom).
16+
To try out Axiom without registration, see [Explore Axiom Playground](/getting-started-guide/explore-axiom-playground).
2117

2218
## 1. Explore sample data
2319

2420
1. [Sign up for an Axiom account](https://app.axiom.co/register). All you need is an email address.
2521
1. Click the **Datasets** tab on the top of the page.
26-
1. In the list of datasets, click `sample-http-logs`.
22+
1. In the list of datasets, click `otel-demo-traces`.
2723

28-
This displays the fields in the sample dataset `sample-http-logs`. In Axiom, an individual piece of data is an event, and a dataset is a collection of similar events. In this example, an event is an HTTP request to your website, and the dataset holds incoming data about all these HTTP requests.
24+
This displays the fields in the sample dataset `otel-demo-traces`.
2925

3026
## 2. Display stream of incoming data
3127

3228
1. Click the **Stream** tab on the top of the page.
33-
1. Click **sample-http-logs** in the list.
29+
1. Click **otel-demo-traces** in the list.
3430

35-
You see the data that Axiom receives realtime. In this example, this page displays the HTTP requests to your imaginary website.
31+
You see the data that Axiom receives realtime.
3632

3733
## 3. Analyze data
3834

3935
### Query data
4036

4137
1. Click the **Query** tab on the top of the page, and then click **Builder** in the top left. This enables you to query your data with a visual query builder.
42-
1. In the **Dataset** section, select **sample-http-logs** from the list of datasets.
38+
1. In the **Dataset** section, select **otel-demo-tracess** from the list of datasets.
4339
1. In the **Where** section, click **+**.
44-
1. Write **status == "500"**, and then press **Enter**.
40+
1. Write **service.name == frontend**, and then press **Enter**.
4541
1. Click **Run**.
4642

47-
You see all the HTTP requests with the status 500. This is important to know because this status indicates an internal server error, meaning that the server has encountered a situation that it can’t handle.
43+
You see all the traces for the Frontend service.
4844

4945
### Run an APL query
5046

5147
1. Click the **Query** tab on the top of the page, and then click **APL** in the top left. This enables you to query your data with the Axiom Processing Language (APL). For more information, see [Introduction to APL](/apl/introduction).
5248
1. In the text field, enter the following:
5349
```kusto
54-
['sample-http-logs']
55-
| summarize count() by bin_auto(_time), status
50+
['otel-demo-traces']
51+
| where duration > 5ms
52+
| summarize count() by bin_auto(_time), ['service.name']
5653
```
5754
1. Click **Run**.
5855

59-
You see the number of HTTP requests of each status over time.
56+
You see the number of requests taking longer than 5ms for each service over time.
6057

6158
## 4. Visualize data
6259

6360
1. Click the **Dashboards** tab on the top of the page.
64-
1. Click **Http logs** in the list.
61+
1. Click **OpenTelemetry Traces (otel-demo-traces)** in the list.
6562

66-
You see a dashboard that displays important information about the HTTP requests to the website.
63+
You see a dashboard that displays important information about the OTel traces.
6764

6865
## 5. Create new dashboard
6966

@@ -105,4 +102,4 @@ You created a monitor that automatically sends a notification to your email addr
105102

106103
## What's next
107104

108-
To start integrating Axiom into your system, see [Integrate Axiom into your system](/getting-started-guide/integrate-axiom).
105+
To check out Axiom with an example Node.js app, see [Get started with example app](/getting-started-guide/get-started-example-app).
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 'Try out Axiom'
3+
excerpt: 'This section offers a hands-on experience of Axiom and its features.'
4+
sidebarTitle: Overview
5+
---
6+
7+
The following pages offer a hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data:
8+
9+
<Card
10+
title="Explore Axiom Playground"
11+
href="/getting-started-guide/explore-axiom-playground"
12+
>
13+
Explore Axiom without registration
14+
</Card>
15+
16+
<Card
17+
title="Quickstart using sample data"
18+
href="/getting-started-guide/quickstart-using-sample-data"
19+
>
20+
Try out Axiom with sample data
21+
</Card>
22+
23+
<Card
24+
title="Get started with example app"
25+
href="/getting-started-guide/get-started-example-app"
26+
>
27+
Check out Axiom with an example Node.js app
28+
</Card>
29+
30+
For a more educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering, see [Learn about Axiom](/getting-started-guide/learn-about-axiom).

0 commit comments

Comments
 (0)