-
Notifications
You must be signed in to change notification settings - Fork 586
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Add placeholder pages for intro (#2834)
* Add placeholder pages for intro * Apply suggestions from code review
- Loading branch information
1 parent
3f6c051
commit 053ca72
Showing
3 changed files
with
100 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: What is Pyroscope? | ||
menuTitle: What is Pyroscope? | ||
description: Learn about Pyrsocope and profiling. | ||
weight: 10 | ||
draft: true | ||
keywords: | ||
- Pyroscope | ||
- Profiling | ||
--- | ||
|
||
<!-- This is placeholder page while we get the content written. --> | ||
|
||
# What is Pyroscope? | ||
|
||
<!-- The concept title is required. Use a noun-based title that includes the name of the product or feature. For example: Alerting fundamentals. | ||
A concept provides an overview and background information to help users understand a product, interface, or task. Concepts answer the question “what is it?”. Readers learn about features through concepts. Concepts do not include step-by-step procedures or reference material but often link to those materials. | ||
Refer to the [Concept topic documentation](https://grafana.com/docs/writers-toolkit/writing-guide/topic-types/concept/) for guidelines on writing a concept topic. | ||
--> | ||
|
||
Introduce the concept. | ||
|
||
<!-- The introduction is required. Add an introduction to the concept to summarize the purpose or main point of the feature. --> | ||
|
||
## Sections | ||
|
||
<!-- Add sections replacing **Sections** with subtitles for each section. Concept topics or sections explain what and why. They do not explain how. If you are a new user, you might look for concept information to learn about what Grafana is, why it might be useful to you, and what the general workflow is. --> | ||
|
||
## Useful links | ||
|
||
<!-- Link out to task or reference topics related to the concept. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: Profiling examples | ||
menuTitle: Profiling examples | ||
description: What can you do with profiling data to resolve real-world problems? | ||
weight: 100 | ||
draft: true | ||
keywords: | ||
- Pyroscope | ||
- Profiling | ||
--- | ||
|
||
<!-- This is placeholder page while we get the content written. --> | ||
|
||
# Profiling examples | ||
|
||
<!-- The concept title is required. Use a noun-based title that includes the name of the product or feature. For example: Alerting fundamentals. | ||
A concept provides an overview and background information to help users understand a product, interface, or task. Concepts answer the question “what is it?”. Readers learn about features through concepts. Concepts do not include step-by-step procedures or reference material but often link to those materials. | ||
Refer to the [Concept topic documentation](https://grafana.com/docs/writers-toolkit/writing-guide/topic-types/concept/) for guidelines on writing a concept topic. | ||
--> | ||
|
||
Introduce the concept. | ||
|
||
<!-- The introduction is required. Add an introduction to the concept to summarize the purpose or main point of the feature. --> | ||
|
||
## Sections | ||
|
||
<!-- Add sections replacing **Sections** with subtitles for each section. Concept topics or sections explain what and why. They do not explain how. If you are a new user, you might look for concept information to learn about what Grafana is, why it might be useful to you, and what the general workflow is. --> | ||
|
||
## Useful links | ||
|
||
<!-- Link out to task or reference topics related to the concept. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Pyroscope and profiling in Grafana | ||
menuTitle: Pyroscope in Grafana | ||
description: Learn about how you can use profile data in Grafana. | ||
weight: 200 | ||
draft: true | ||
keywords: | ||
- Pyroscope | ||
- Profiling | ||
- Grafana | ||
--- | ||
|
||
<!-- This is placeholder page while we get the content written. --> | ||
|
||
# Pyroscope and profiling in Grafana | ||
|
||
<!-- The concept title is required. Use a noun-based title that includes the name of the product or feature. For example: Alerting fundamentals. | ||
A concept provides an overview and background information to help users understand a product, interface, or task. Concepts answer the question “what is it?”. Readers learn about features through concepts. Concepts do not include step-by-step procedures or reference material but often link to those materials. | ||
Refer to the [Concept topic documentation](https://grafana.com/docs/writers-toolkit/writing-guide/topic-types/concept/) for guidelines on writing a concept topic. | ||
--> | ||
|
||
Introduce the concept. | ||
|
||
<!-- The introduction is required. Add an introduction to the concept to summarize the purpose or main point of the feature. --> | ||
|
||
## Sections | ||
|
||
<!-- Add sections replacing **Sections** with subtitles for each section. Concept topics or sections explain what and why. They do not explain how. If you are a new user, you might look for concept information to learn about what Grafana is, why it might be useful to you, and what the general workflow is. --> | ||
|
||
## Useful links | ||
|
||
<!-- Link out to task or reference topics related to the concept. --> |