Fix broken links in the documentation (#39)

Fixes #40
bakdata · Dec 22, 2022 · d1c7808 · d1c7808
1 parent f3a742a
commit d1c7808
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 8 deletions.
diff --git a/docs/docs/user/examples/atm-fraud-pipeline.md b/docs/docs/user/examples/atm-fraud-pipeline.md
@@ -14,7 +14,7 @@ The one used in this example is re-built from scratch using [bakdata](https://ba
 
 ## Prerequisites
 
-Completed all steps in the [setup](/user/getting-started/setup).
+Completed all steps in the [setup](../getting-started/setup.md).
 
 ## Setup and deployment
 
@@ -100,7 +100,7 @@ After that open [http://localhost:8080](http://localhost:8080) in your browser.
 You should be able to see pipeline shown in the image below:
 
 <figure markdown>
-  ![atm-fraud-pipeline](/images/atm-fraud-pipeline_streams-explorer.png)
+  ![atm-fraud-pipeline](../../images/atm-fraud-pipeline_streams-explorer.png)
   <figcaption>An overview of ATM fraud pipeline shown in Streams Explorer</figcaption>
 </figure>
 
@@ -143,7 +143,7 @@ helm --namespace kpops uninstall postgresql
     destroyed correctly.
 
 !!! Attention
-    If you face any issues destroying this example see [Teardown](/user/getting-started/teardown) for manual deletion.
+    If you face any issues destroying this example see [Teardown](../getting-started/teardown.md) for manual deletion.
 
 ## Common errors
 
@@ -157,4 +157,4 @@ helm --namespace kpops uninstall postgresql
     1. Read the error message.
     2. Try to correct the indicated mistakes if there were any. Likely the configuration is not correct or the port-forwarding is not working as intended.
     3. Run `clean`.
-    4. If `clean` fails, follow the steps in [teardown](/user/getting-started/teardown).
+    4. If `clean` fails, follow the steps in [teardown](../getting-started/teardown.md).
diff --git a/docs/docs/user/getting-started/setup.md b/docs/docs/user/getting-started/setup.md
@@ -78,7 +78,8 @@ To deploy Kafka, this guide uses Confluent's [Helm chart](https://github.com/con
         docker push localhost:12345/kafka-connect-jdbc:7.1.3
         ```
 
-    Detailed instructions on building, tagging and pushing a docker image can be found in [Docker docs](https://docs.docker.com/).
+    Detailed instructions on building, 
+    tagging and pushing a docker image can be found in [Docker docs](https://docs.docker.com/).
 
 2. Add Confluent's Helm chart repository and update the index:
 

diff --git a/docs/docs/user/index.md b/docs/docs/user/index.md
@@ -11,6 +11,6 @@ addition, Kafka apps and its resources can be reset or cleaned up again with a s
 
 The user guide is split into three parts:
 
-- [Getting Started](./getting-started/)
-- [Examples](./examples/)
-- [References](./references/)
+- [Getting Started](getting-started)
+- [Examples](examples)
+- [References](references)
diff --git a/docs/docs/user/references/index.md b/docs/docs/user/references/index.md
@@ -0,0 +1,5 @@
+# References
+The references section gives you an overview of:
+
+- [CLI commands](./cli-commands.md)
+- [KPOps variables](./variables.md)
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -72,5 +72,6 @@ nav:
       - user/examples/index.md
       - user/examples/atm-fraud-pipeline.md
     - References:
+      - user/references/index.md
       - user/references/cli-commands.md
       - user/references/variables.md