From 69043f61006c10d6d79db91abe65fabf292d1194 Mon Sep 17 00:00:00 2001 From: Allan Brighton Date: Wed, 27 Nov 2024 11:31:20 +0100 Subject: [PATCH] Fixed links in documentation after paradox validate links failed --- docs/src/main/apps/csweventcli.md | 2 +- docs/src/main/commons/apps.md | 2 +- docs/src/main/commons/getting-started.md | 2 +- docs/src/main/commons/logging_aggregator.md | 2 +- docs/src/main/technical/aas/aas.md | 2 +- docs/src/main/technical/alarm/alarm.md | 4 ++-- docs/src/main/technical/event/event.md | 10 +++++----- docs/src/main/technical/framework/framework.md | 2 +- docs/src/main/technical/location/location-server.md | 2 +- docs/src/main/technical/time/time.md | 3 +-- 10 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/src/main/apps/csweventcli.md b/docs/src/main/apps/csweventcli.md index 35ae9fb4cc..bb963ea0d9 100644 --- a/docs/src/main/apps/csweventcli.md +++ b/docs/src/main/apps/csweventcli.md @@ -236,4 +236,4 @@ You can explicitly pass the hostname and port of the Redis server while running $ redis-cli -h redis.tmt.org -p 6379 ``` -A detailed list of operations you can perform with `redis-cli` can be found [here](https://redis.io/docs/manual/cli/) +A detailed list of operations you can perform with `redis-cli` can be found [here](https://redis.io/docs/latest/develop/tools/cli/) diff --git a/docs/src/main/commons/apps.md b/docs/src/main/commons/apps.md index 3268651ac2..335ebbfe19 100644 --- a/docs/src/main/commons/apps.md +++ b/docs/src/main/commons/apps.md @@ -35,7 +35,7 @@ apply the proper context: ```console $ chcon -R system_u:object_r:admin_home_t:s0 docker-elk/ ``` -To know more about running Docker for Mac please refer to this [link](https://docs.docker.com/desktop/install/mac-install/). For Windows, ensure that the +To know more about running Docker for Mac please refer to this [link](https://docs.docker.com/desktop/setup/install/mac-install/). For Windows, ensure that the "Shared Drives" feature is enabled for the `C:` drive (Docker for Windows > Settings > Shared Drives). See [Configuring Docker for Windows Shared Drives](https://learn.microsoft.com/en-us/archive/blogs/stevelasker/configuring-docker-for-windows-volumes) (MSDN Blog). diff --git a/docs/src/main/commons/getting-started.md b/docs/src/main/commons/getting-started.md index fc6095e938..8da1500c45 100644 --- a/docs/src/main/commons/getting-started.md +++ b/docs/src/main/commons/getting-started.md @@ -15,7 +15,7 @@ Supported Operating Systems are: CentOS and MacOS 3. Install following IntelliJ Plugins - [Scala](https://plugins.jetbrains.com/plugin/1347-scala) - [Scalafmt](https://plugins.jetbrains.com/plugin/8236-scalafmt) -4. Install [Redis](https://redis.io/download/) - Version should be greater than 4.0.0 +4. Install [Redis](https://redis.io/downloads/) - Version should be greater than 4.0.0 5. Recommended testing frameworks/tools: - [ScalaTest](https://www.scalatest.org/) - [JUnit](https://junit.org/junit4/), JUnit Interface diff --git a/docs/src/main/commons/logging_aggregator.md b/docs/src/main/commons/logging_aggregator.md index 04bda6a425..368080aba0 100644 --- a/docs/src/main/commons/logging_aggregator.md +++ b/docs/src/main/commons/logging_aggregator.md @@ -315,6 +315,6 @@ To know more about setting up docker and starting Elastic, please refer to @ref: @@@ note By default, Elasticsearch will run in a read-only mode if the disk it is using is more than 90% full. This can be configured. -See the [Elasticsearch reference documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/disk-allocator.html) +See the [Elasticsearch reference documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html#disk-based-shard-allocation) @@@ diff --git a/docs/src/main/technical/aas/aas.md b/docs/src/main/technical/aas/aas.md index b47b46de0a..3c297d3bbe 100644 --- a/docs/src/main/technical/aas/aas.md +++ b/docs/src/main/technical/aas/aas.md @@ -11,7 +11,7 @@ It provides following libraries (aka adapters). For information on _using_ these - @ref:[Installed Auth Adapter - csw-aas-installed](../../services/aas/csw-aas-installed.md) - enables security for CLI applications - @extref[Javascript Adapter - ESW-TS](esw_ts:aas/auth-components.html) - enables security for Javascript React applications -These adapters are written on top of [client adapters](https://www.keycloak.org/docs/18.0/securing_apps/#client-adapters) provided by Keycloak. +These adapters are written on top of [client adapters](https://www.keycloak.org/securing-apps/javascript-adapter) provided by Keycloak. ![AAS Adapters](aas-adapters.png) diff --git a/docs/src/main/technical/alarm/alarm.md b/docs/src/main/technical/alarm/alarm.md index 09a7d165d5..bdc1b34eb5 100644 --- a/docs/src/main/technical/alarm/alarm.md +++ b/docs/src/main/technical/alarm/alarm.md @@ -10,13 +10,13 @@ The Alarm Service also provides mechanisms to monitor the health of all componen ## Technology Alarm Service uses [Redis](https://redis.io/) for persistence. Redis provides -[Keyspace Notifications](https://redis.io/docs/manual/keyspace-notifications/) which allows clients to subscribe to Pub/Sub channels +[Keyspace Notifications](https://redis.io/docs/latest/develop/use/keyspace-notifications/) which allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. ![Alarm Dependencies](alarm-layers.png) We have created a layer i.e. "Romaine" which converts redis events into an [akka stream](https://doc.akka.io/libraries/akka-core/current/stream/index.html). -Romaine internally uses a java redis library called [Lettuce](https://lettuce.io/). +Romaine internally uses a java redis library called [Lettuce](https://redis.github.io/lettuce/). ## Severities diff --git a/docs/src/main/technical/event/event.md b/docs/src/main/technical/event/event.md index 968f8615d5..4c5bfc3925 100644 --- a/docs/src/main/technical/event/event.md +++ b/docs/src/main/technical/event/event.md @@ -64,8 +64,8 @@ When to use which API is documented in @ref[this section](../../services/event.md#accessing-event-service) of the Event Service programming documentation. -Event Service uses [Redis' PubSub](https://redis.io/docs/manual/pubsub/) for publishing and subscribing to events. -And to support the feature of `getting` the latest event on a subscription, the [set operation](https://redis.io/commands/set/) of Redis DB is used. +Event Service uses [Redis' PubSub](https://redis.io/docs/latest/develop/interact/pubsub/) for publishing and subscribing to events. +And to support the feature of `getting` the latest event on a subscription, the [set operation](https://redis.io/docs/latest/commands/set/) of Redis DB is used. ## Romaine @@ -73,7 +73,7 @@ At a lower level, we have created a library called "Romaine" to communicate more ![Event Dependencies](event-layers.png) -Romaine is a Scala library built over the Java Redis client library called [Lettuce](https://lettuce.io/). +Romaine is a Scala library built over the Java Redis client library called [Lettuce](https://redis.github.io/lettuce/). Romaine provides additional rich APIs over the existing functionality offered by Lettuce including these additional APIs useful to CSW: * **Async API:** Provides asynchronous API (`romaine.async.RedisAsyncApi`) for various redis commands like `get`, `set`, `publish` etc. @@ -81,7 +81,7 @@ Romaine provides additional rich APIs over the existing functionality offered by * **Reactive API:** Provides API for Subscription and Pattern-Subscription (`romaine.reactive.RedisSubscriptionApi`). On subscription, it returns an [Akka Stream](https://doc.akka.io/libraries/akka-core/current/stream/index.html) of Events which on execution materializes to `RedisSubscription` instance which gives handle to unsubscribe to events. -* **Keyspace API:** Provides APIs to watch [Keyspace Notifications](https://redis.io/docs/manual/keyspace-notifications/) (`romaine.keyspace.RedisKeySpaceApi`). +* **Keyspace API:** Provides APIs to watch [Keyspace Notifications](https://redis.io/docs/latest/develop/use/keyspace-notifications/) (`romaine.keyspace.RedisKeySpaceApi`). This is a rich API built on Akka Streams which provides not just the change events that happen on keys (for eg: Update, Removal etc.) but also the old and new values corresponding to those keys. Event Service uses `Async API` for publishing and setting the latest event, and `Reactive API` for subscribing to events and patterns. @@ -117,7 +117,7 @@ In case, when the underlying event implementation is not available, the Subscrib ## Architecture In order to allow components to discover Event Service, it is necessary to register it with the Location Service including the underlying product, -which here refers to the Redis instance (particularly [Redis Sentinel](https://redis.io/docs/manual/sentinel/)). +which here refers to the Redis instance (particularly [Redis Sentinel](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/)). For high availability of Event Service, we use the Redis Sentinel along with master and slave instances of Redis. Master and slave are configured in "replication" mode. diff --git a/docs/src/main/technical/framework/framework.md b/docs/src/main/technical/framework/framework.md index 039da3f69a..3d84434975 100644 --- a/docs/src/main/technical/framework/framework.md +++ b/docs/src/main/technical/framework/framework.md @@ -11,7 +11,7 @@ The common software framework is a library that provides set of APIs used for: - receiving responses from components - deploying component in container or standalone mode -The CSW framework is implemented using [Akka typed actors](https://doc.akka.io/libraries/akka-core/current/typed/index.htmls). +The CSW framework is implemented using [Akka typed actors](https://doc.akka.io/libraries/akka-core/2.5/typed-actors.html). @@@ note {title="IMPORTANT!!!"} diff --git a/docs/src/main/technical/location/location-server.md b/docs/src/main/technical/location/location-server.md index e4910bc18d..144aafe758 100644 --- a/docs/src/main/technical/location/location-server.md +++ b/docs/src/main/technical/location/location-server.md @@ -36,7 +36,7 @@ By default, this actor system binds to port `3552`. Initially when there is no m Such a node is referred as seed node (introducer) and the location of this node needs to be known so that other nodes can join to this known address and form a larger cluster. After the joining process is complete, seed nodes are not special and they participate in the cluster in exactly the same way as other nodes. -Akka Cluster provides cluster [membership](https://doc.akka.io/libraries/akksa-core/current/typed/cluster-membership.html) service using [gossip](https://doc.akka.io/docs/akka/current/typed/cluster-concepts.html#gossip) +Akka Cluster provides cluster [membership](https://doc.akka.io/libraries/akka-core/current/typed/cluster-membership.html) service using [gossip](https://doc.akka.io/libraries/akka-core/current/typed/cluster-concepts.html#gossip) protocols and an automatic [failure detector](https://doc.akka.io/libraries/akka-core/current/typed/cluster-concepts.html#failure-detector). Death watch uses the cluster failure detector for nodes in the cluster, i.e. it detects network failures and JVM crashes, in addition to graceful termination of watched actor. diff --git a/docs/src/main/technical/time/time.md b/docs/src/main/technical/time/time.md index cb64262f7c..fad086c1c4 100644 --- a/docs/src/main/technical/time/time.md +++ b/docs/src/main/technical/time/time.md @@ -141,8 +141,7 @@ In case of TMT most of the synchronization components will be based on Linux operating system. For understanding the internal working of Linux clock one can refer to [this short description](http://btorpey.github.io/blog/2014/02/18/clock-sources-in-linux/#fnref:1) -or follow ‘Chapter 6’ of [the detailed -document](https://doc.lagout.org/operating%20system%20/linux/Understanding%20Linux%20Kernel.pdf). +or follow ‘Chapter 6’ of [the detailed document](https://doc.lagout.org/operating%20system%20/linux/Understanding%20Linux%20Kernel.pdf). The block diagram of an ordinary clock is shown in the following figure. ![block diagram](block-diagram-ordinary-clock.png)