diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml index 5082780ac..7ca7128b5 100644 --- a/.github/workflows/github-pages.yaml +++ b/.github/workflows/github-pages.yaml @@ -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: diff --git a/docs/content/getting-started/quickstart.md b/docs/content/getting-started/quickstart.md index 78ba388ee..d4598ee0a 100644 --- a/docs/content/getting-started/quickstart.md +++ b/docs/content/getting-started/quickstart.md @@ -5,6 +5,8 @@ weight: 0 This tutorial shows the quickest way to get started with the Prometheus Java metrics library. +{{< toc >}} + # Dependencies We use the following dependencies: @@ -12,7 +14,7 @@ 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' @@ -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. @@ -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: