From fe20d4ed6537d79ac27d0b312f0507fe5c5218bb Mon Sep 17 00:00:00 2001 From: Renato Cavalcanti Date: Fri, 22 Feb 2019 12:53:23 +0100 Subject: [PATCH] Fix some links and typo (#469) * Fix links * typo --- docs/src/main/paradox/cluster-http-management.md | 4 ++-- docs/src/main/paradox/healthchecks.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/main/paradox/cluster-http-management.md b/docs/src/main/paradox/cluster-http-management.md index ef139ae10..50e1aa9b6 100644 --- a/docs/src/main/paradox/cluster-http-management.md +++ b/docs/src/main/paradox/cluster-http-management.md @@ -1,8 +1,8 @@ # Cluster Http Management -Akka Management Cluster HTTP is a Management extension that allows you interaction with an `akka-cluster` through an HTTP interface. -This management extension exposes different operations to manage nodes in a cluster as well as a health checks based +Akka Management Cluster HTTP is a Management extension that allows interaction with an `akka-cluster` through an HTTP interface. +This management extension exposes different operations to manage nodes in a cluster as well as health checks based on the cluster state. The operations exposed are comparable to the Command Line Management tool or the JMX interface `akka-cluster` provides. diff --git a/docs/src/main/paradox/healthchecks.md b/docs/src/main/paradox/healthchecks.md index 261a85c5d..9074d6a44 100644 --- a/docs/src/main/paradox/healthchecks.md +++ b/docs/src/main/paradox/healthchecks.md @@ -38,13 +38,13 @@ Scala Java : @@snip [ExampleHealthCheck.java](/management/src/test/java/jdoc/akka/management/ClusterCheck.java) { #cluster } -Note that [Cluster Http Management](cluster-http-management.md) includes a health check for cluster membership that is configurable for which states are considered healthy. +Note that @ref:[Cluster Http Management](cluster-http-management.md) includes a health check for cluster membership that is configurable for which states are considered healthy. Any of the above health checks can be configured as either readiness checks or liveness checks. ## Configuring health checks -Health checks are picked up from configuration. Modules are expected to provide health checks e.g. [Cluster Http Management](cluster-http-management.md) provides a cluster readiness check. +Health checks are picked up from configuration. Modules are expected to provide health checks e.g. @ref:[Cluster Http Management](cluster-http-management.md) provides a cluster readiness check. Application specific health checks can be added a `name = ` to `akka.management.health-checks.readiness-checks` or `akka.management.health-checks.liveness-checks` e.g.