Skip to content

Commit

Permalink
Merge pull request grafana/phlare#427 from grafana/fix-doc
Browse files Browse the repository at this point in the history
Fixes latest docs validation link to grafana.com
  • Loading branch information
simonswine authored Nov 21, 2022
2 parents bca57c2 + 18f110f commit a22be89
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 15 deletions.
1 change: 1 addition & 0 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Grafana Phlare documentation"
menuTitle: "Grafana Phlare"
weight: 1
description: "Grafana Phlare documentation"
keywords:
- Grafana Phlare
- Grafana profiles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ To start a standalone agent, you can use the following command:
./phlare -target=agent -config.file=/path/to/agent-config.yaml
```

In the future, the agent will be integrated into the [Grafana Agent](https://grafana.com/docs/tempo/latest/grafana-agent/), which will remove the needs to run a standalone agent if you're already running the Grafana Agent.
In the future, the agent will be integrated into the [Grafana Agent](/docs/agent/latest/), which will remove the need to run a standalone agent if you're already running the Grafana Agent.
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ weight: 30

Continuous profiling support in the [Grafana Agent] is coming soon.

[Grafana Agent]: https://grafana.com/docs/agent/latest/
[Grafana Agent]: /docs/agent/latest/
6 changes: 3 additions & 3 deletions docs/sources/operators-guide/deploy-kubernetes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Use a custom namespace so that you do not have to overwrite the default namespac
--set-string 'podAnnotations.phlare\.grafana\.com/scrape=true' \
--set-string 'podAnnotations.phlare\.grafana\.com/port=6060'
```
For details, see [Deploy Grafana on Kubernetes](https://grafana.com/docs/grafana/latest/setup-grafana/installation/kubernetes/).
For details, see [Deploy Grafana on Kubernetes](/docs/grafana/latest/setup-grafana/installation/kubernetes/).

1. Port-forward Grafana to `localhost`, by using the `kubectl` command:

Expand All @@ -136,11 +136,11 @@ Use a custom namespace so that you do not have to overwrite the default namespac
| Name | Phlare |
| URL | http://phlare-querier.phlare-test.svc.cluster.local.:4100/ |

To add a data source, see [Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/).
To add a data source, see [Add a data source](/docs/grafana/latest/datasources/add-a-data-source/).

1. Verify success:

You should be able to query profiles in [Grafana Explore](https://grafana.com/docs/grafana/latest/explore/),
You should be able to query profiles in [Grafana Explore](/docs/grafana/latest/explore/),
as well as create dashboard panels by using your newly configured Phlare data source.

## Optional: Persistently add data source:
Expand Down
18 changes: 9 additions & 9 deletions docs/sources/operators-guide/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: 10

Choose one of the following options to get started with Grafana Phlare:

- The **written tutorial** below provides a series of imperative commands to start a single Phlare process, or [monolith]({{< relref "../architecture/deployment-modes/index.md#monolithic-mode" >}}), which is designed for users getting started with the project.
- The **written tutorial** below provides a series of imperative commands to start a single Phlare process, or [monolith]({{< relref "../architecture/deployment-modes/index.md#monolithic-mode" >}}), which is designed for users getting started with the project.

- The following **video tutorial** uses [`docker-compose`](https://github.com/grafana/phlare/tree/main/tools/docker-compose) to declaratively deploy Phlare and Grafana.

Expand All @@ -26,8 +26,8 @@ Verify that you have installed [Docker](https://docs.docker.com/engine/install/)
## Download and configure Phlare

1. Download Grafana Phlare.
You can use Docker or download a binary to install Phlare.

You can use Docker or download a binary to install Phlare.

- To install with Docker, run the following command:

Expand All @@ -48,8 +48,8 @@ Verify that you have installed [Docker](https://docs.docker.com/engine/install/)

1. Start Phlare.

To run Grafana Phlare as a monolith and with local filesystem storage, you can create your own file, or use a demo configuration file.
To run Grafana Phlare as a monolith and with local filesystem storage, you can create your own file, or use a demo configuration file.

- To create your own file, write the following YAML configuration to a file called `demo.yaml`:

```yaml
Expand Down Expand Up @@ -84,7 +84,7 @@ Verify that you have installed [Docker](https://docs.docker.com/engine/install/)
./phlare --config.file=./demo.yaml
```

1. Verify that Phlare is ready. Grafana Phlare listens on port `4100`.
1. Verify that Phlare is ready. Grafana Phlare listens on port `4100`.

```bash
curl localhost:4100/ready
Expand Down Expand Up @@ -116,7 +116,7 @@ Verify that you have installed [Docker](https://docs.docker.com/engine/install/)
| Name | Phlare |
| URL | [http://phlare:4100/](http://phlare:4100/) |

To learn more about adding data sources, see [Add a data source](https://grafana.com/docs/grafana/latest/datasources/add-a-data-source/).
To learn more about adding data sources, see [Add a data source](/docs/grafana/latest/datasources/add-a-data-source/).

When you have completed the tasks in this getting started guide, you can query profiles in [Grafana Explore](https://grafana.com/docs/grafana/latest/explore/)
and create dashboard panels using the newly configured Grafana Phlare data source. For more information on working with dashboards with Grafana, see [Panels and visualizations](https://grafana.com/docs/grafana/latest/panels-visualizations/) in the Grafana documentation.
When you have completed the tasks in this getting started guide, you can query profiles in [Grafana Explore](/docs/grafana/latest/explore/)
and create dashboard panels using the newly configured Grafana Phlare data source. For more information on working with dashboards with Grafana, see [Panels and visualizations](/docs/grafana/latest/panels-visualizations/) in the Grafana documentation.
2 changes: 1 addition & 1 deletion docs/sources/release-notes/v0.1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ From the first release you can expect:

![Grafana Phlare UI](phlare-ui.png)

Ready to give it a try, follow our [getting started](https://grafana.com/docs/phlare/latest/operators-guide/get-started/) documentation.
Ready to give it a try, follow our [getting started]({{< relref "../../operators-guide/get-started/" >}}) documentation.

> **Note:** This is an early release and there are a couple of limitations:
>
Expand Down

0 comments on commit a22be89

Please sign in to comment.