Skip to content

Commit

Permalink
fix gh pages (#1201)
Browse files Browse the repository at this point in the history
* debug script

Signed-off-by: Gregor Zeitlinger <[email protected]>

* notes

Signed-off-by: Gregor Zeitlinger <[email protected]>

* fetch tags

Signed-off-by: Gregor Zeitlinger <[email protected]>

* fix tabs

Signed-off-by: Gregor Zeitlinger <[email protected]>

---------

Signed-off-by: Gregor Zeitlinger <[email protected]>
  • Loading branch information
zeitlinger authored Nov 12, 2024
1 parent b0693fa commit d6572b7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/github-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-tags: 'true'
fetch-depth: 0
- name: Set up JDK
uses: actions/setup-java@v4
with:
Expand Down
14 changes: 8 additions & 6 deletions docs/content/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ weight: 0

This tutorial shows the quickest way to get started with the Prometheus Java metrics library.

{{< toc >}}

# Dependencies

We use the following dependencies:

* `prometheus-metrics-core` is the actual metrics library.
* `prometheus-metrics-instrumentation-jvm` provides out-of-the-box JVM metrics.
* `prometheus-metrics-exporter-httpserver` is a standalone HTTP server for exposing Prometheus metrics.
{{< tabs "uniqueid" >}}
{{< tabs "deps" >}}
{{< tab "Gradle" >}}
```
implementation 'io.prometheus:prometheus-metrics-core:$version'
Expand Down Expand Up @@ -52,7 +54,7 @@ This is especially important when using Spring Boot, which manages some of the d

You should omit the version number of the dependencies in your build file if you are using a BOM.

{{< tabs "uniqueid" >}}
{{< tabs "bom" >}}
{{< tab "Gradle" >}}

You have two ways to import a BOM.
Expand Down Expand Up @@ -89,25 +91,25 @@ dependencyManagement {
}
```

{{% alert title="Note" color="info" %}}
{{< hint type=note >}}

Be careful not to mix up the different ways of configuring things with Gradle.
For example, don't use
`implementation(platform("io.prometheus:prometheus-metrics-bom:$version"))`
with the `io.spring.dependency-management` plugin.

{{% /alert %}}
{{< /hint >}}

{{< /tab >}}
{{< tab "Maven" >}}

{{% alert title="Note" color="info" %}}
{{< hint type=note >}}

Import the Prometheus Java metrics BOMs before any other BOMs in your
project. For example, if you import the `spring-boot-dependencies` BOM, you have
to declare it after the Prometheus Java metrics BOMs.

{{% /alert %}}
{{< /hint >}}

The following example shows how to import the Prometheus Java metrics BOMs using Maven:

Expand Down

0 comments on commit d6572b7

Please sign in to comment.