Skip to content

Commit e838e48

Browse files
authored
* Fix #4147: Broken links at https://redis.github.io/jedis/ * Use absolute links in README.md and avoid duplicating the content * Add missing slash
1 parent d6baa75 commit e838e48

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Release](https://img.shields.io/github/release/redis/jedis.svg?sort=semver)](https://github.com/redis/jedis/releases/latest)
44
[![Maven Central](https://img.shields.io/maven-central/v/redis.clients/jedis.svg)](https://central.sonatype.com/artifact/redis.clients/jedis)
55
[![Javadocs](https://www.javadoc.io/badge/redis.clients/jedis.svg)](https://www.javadoc.io/doc/redis.clients/jedis)
6-
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
6+
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/redis/jedis/blob/master/LICENSE)
77
[![codecov](https://codecov.io/gh/redis/jedis/branch/master/graph/badge.svg?token=pAstxAAjYo)](https://codecov.io/gh/redis/jedis)
88
[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/redis)
99

@@ -57,7 +57,7 @@ To get started with Jedis, first add it as a dependency in your Java project. If
5757
</dependency>
5858
```
5959

60-
To use the cutting-edge Jedis, check [here](/docs/jedis-maven.md).
60+
To use the cutting-edge Jedis, check [here](https://redis.github.io/jedis/jedis-maven/).
6161

6262
Next, you'll need to connect to Redis. Consider installing a redis server with docker:
6363

@@ -124,7 +124,7 @@ jedis.sadd("planets", "Mars");
124124
Jedis includes support for [Redis modules](https://redis.io/docs/modules/) such as
125125
[RedisJSON](https://redis.io/json/) and [RediSearch](https://redis.io/search/).
126126

127-
See the [RedisJSON Jedis](docs/redisjson.md) or [RediSearch Jedis](docs/redisearch.md) for details.
127+
See the [RedisJSON Jedis](https://redis.github.io/jedis/redisjson/) or [RediSearch Jedis](https://redis.github.io/jedis/redisearch/) for details.
128128

129129
## Failover
130130

@@ -133,15 +133,15 @@ Jedis supports retry and failover for your Redis deployments. This is useful whe
133133
1. You have more than one Redis deployment. This might include two independent Redis servers or two or more Redis databases replicated across multiple [active-active Redis Enterprise](https://redis.io/docs/latest/operate/rs/databases/active-active/) clusters.
134134
2. You want your application to connect to one deployment at a time and to fail over to the next available deployment if the first deployment becomes unavailable.
135135

136-
For the complete failover configuration options and examples, see the [Jedis failover docs](docs/failover.md).
136+
For the complete failover configuration options and examples, see the [Jedis failover docs](https://redis.github.io/jedis/failover/).
137137

138138
## Token-Based Authentication
139139

140140
Jedis supports Token-Based authentication (TBA) starting with 5.3.0 GA release. This feature is complemented by an extension library that enhances the developer experience and provides most of the components required for TBA functionality.
141141

142142
Notably, the extension library includes built-in support for **Microsoft EntraID**, offering a seamless integration as part of the generic solution.
143143

144-
For more details and examples, please refer to the [Advanced Usage](docs/advanced-usage.md) documentation.
144+
For more details and examples, please refer to the [Advanced Usage](https://redis.github.io/jedis/advanced-usage/) documentation.
145145

146146
## Documentation
147147

@@ -150,7 +150,7 @@ The [Jedis documentation site](https://redis.github.io/jedis/) contains several
150150
You can also check the [latest Jedis Javadocs](https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html).
151151

152152
Some specific use-case examples can be found in [`redis.clients.jedis.examples`
153-
package](src/test/java/redis/clients/jedis/examples/) of the test source codes.
153+
package](https://github.com/redis/jedis/tree/master/src/test/java/redis/clients/jedis/examples/) of the test source codes.
154154

155155
## Troubleshooting
156156

@@ -175,4 +175,4 @@ Jedis is licensed under the [MIT license](https://github.com/redis/jedis/blob/ma
175175

176176
## Sponsorship
177177

178-
[![Redis Logo](redis-logo-full-color-rgb.png)](https://redis.io/)
178+
[![Redis Logo](https://raw.githubusercontent.com/redis/jedis/master/redis-logo-full-color-rgb.png)](https://redis.io/)

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ plugins:
1919

2020
nav:
2121
- Home: index.md
22+
- Jedis Maven: jedis-maven.md
2223
- Migrating to newer versions:
2324
- Jedis 5: breaking-5.md
2425
- Jedis 4:
@@ -35,4 +36,5 @@ nav:
3536
- Tutorials and Examples: tutorials_examples.md
3637
- Jedis Guide: https://redis.io/docs/latest/develop/connect/clients/java/jedis/
3738
- Redis Command Reference: https://redis.io/docs/latest/commands/
39+
- Advanced Usage: advanced-usage.md
3840

0 commit comments

Comments
 (0)