docs: fix broken edit for developer (#756)

Signed-off-by: realanna <[email protected]>
keptn · Feb 3, 2023 · ce6b7f0 · ce6b7f0
1 parent b6b4160
commit ce6b7f0
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,6 +1,6 @@
 DOCREPO := github.com/keptn-sandbox/lifecycle-toolkit-docs
 TMPDIR := $(CURDIR)/tmp
-VOLUMES := -v $(TMPDIR)/lifecycle-toolkit-docs:/src -v $(CURDIR)/content/en/docs:/src/content/en/docs
+VOLUMES := -v $(TMPDIR)/lifecycle-toolkit-docs:/src -v $(CURDIR)/content/en/docs:/src/content/en/docs-dev
 # renovate: datasource=docker depName=klakegg/hugo
 HUGO_VERSION := 0.105.0-ext
 IMAGE := klakegg/hugo:$(HUGO_VERSION)

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,20 @@
+## Choosing where to add documentation
+
+If the change to the docs needs to reflect the next version of KLT, please edit them here, following the instructions below.
+For already existing documentation versions directly edit them from https://github.com/keptn-sandbox/lifecycle-toolkit-docs or from https://lifecycle.keptn.sh/.
+
+## Adding documentation to the dev repo
+
+To verify your changes to the dev documentations you can use the makefile:
+
+````
+cd  lifecycle-toolkit/docs
+
+make clone
+make build
+make server
+````
+
+After the server is running on http://localhost:1314/docs-dev.
+Any modification in the docs folder will be reflected on the server under the dev revision.
+You can modify the content in realtime to verify the correct behaviour of links and such.
diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md
@@ -4,5 +4,6 @@ linktitle: Docs
 description: Learn how to use Keptn.
 cascade:
   type: docs
-
----
+  github_subdir: "docs/content/en/docs"
+  path_base_for_github_subdir: "/content/en/docs-dev"
+---
diff --git a/docs/content/en/docs/getting-started.md b/docs/content/en/docs/getting-started.md
@@ -3,6 +3,9 @@ title: Getting Started
 linktitle: Getting Started
 description: Learn how to use the Keptn Lifecycle Toolkit.
 weight: 15
+cascade:
+  github_subdir: "docs/content/en/docs"
+  path_base_for_github_subdir: "/content/en/docs-dev"
 ---
 
 The Keptn Lifecycle Toolkit makes your deployments observable, brings application-awareness to your Kubernetes cluster and helps you reliably delivering your application with: