From 5fb58ff96fc5e1b105bf116313aa70301e7a1375 Mon Sep 17 00:00:00 2001 From: Soobin Rho Date: Wed, 8 Feb 2023 18:51:19 -0600 Subject: [PATCH] docs: correct three broken internal links (#1526) * docs: correct broken internal link (/docs/maven-example.md) 1. When I was reading the documentation, I noticed that links to other documents inside the repository were giving a 404 error. So, I cloned the repository and found found that all links such as "[Quickstart](/docs/maven-example.md)" were giving the errors. 2. The fix is to remove the `/docs/` part and the `.md` part. 3. I tested these commits with `bundle exec jekyll serve`. All the pages getting changed by the commits now work correctly. * docs: correct broken internal link (/docs/conversion.md) - Removed the `/docs` part and the `.md` part from the link. - Tested with `bundle exec jekyll serve`. - Working correctly now. * docs: correct broken internal link (/docs/installation.md) - Removed the `/docs` part and the `.md` part from the link. - Tested with `bundle exec jekyll serve`. - Working correctly now. --------- Co-authored-by: Charlie Drage --- docs/integrations.md | 4 ++-- docs/maven-example.md | 2 +- docs/user-guide.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/integrations.md b/docs/integrations.md index da52decf..9a366e13 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -53,5 +53,5 @@ Technically, Fabric8 Maven Plugin processes the external docker-compose.yml file **Links:** -- [Quickstart](/docs/maven-example.md) -- [Documentation](https://maven.fabric8.io/#docker-compose) +* [Quickstart](/maven-example) +* [Documentation](https://maven.fabric8.io/#docker-compose) diff --git a/docs/maven-example.md b/docs/maven-example.md index a4b472c4..5165a62a 100644 --- a/docs/maven-example.md +++ b/docs/maven-example.md @@ -16,7 +16,7 @@ Let's deploy a Springboot Java application with Docker Compose file using Fabric - Linux or MacOS or Windows - JDK 1.7+ - [JDK Quick Installation Guide](http://openjdk.java.net/install/) - Maven 3.x+ - [Maven Installation Guide](http://www.baeldung.com/install-maven-on-windows-linux-mac) -- Kompose - [Kompose Installation Guide](/docs/installation.md) +- Kompose - [Kompose Installation Guide](/installation) **1. Clone the example project from GitHub** diff --git a/docs/user-guide.md b/docs/user-guide.md index fdefae57..9519106e 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -472,4 +472,4 @@ For Windows, there is also `credsStore` which is `wincred`. Technically it will Kompose supports Docker Compose versions: 1, 2 and 3. We have limited support on versions 2.1 and 3.2 due to their experimental nature. -A full list on compatibility between all three versions is listed in our [conversion document](/docs/conversion.md) including a list of all incompatible Docker Compose keys. +A full list on compatibility between all three versions is listed in our [conversion document](/conversion) including a list of all incompatible Docker Compose keys.