site/Makefile

-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,10 @@ help: # Show help for each of the Makefile recipes. @@
     serve: # Clean, build, and run the docs site locally.
     	dev/serve.sh
+    .PHONY: serve-local
+    serve-local: # Clean, build, and run the docs site locally using local docs.
+    	dev/serve.sh --local
     .PHONY: build
     build: # Clean and build the docs site locally.
     	dev/build.sh
@@ Expand Down @@

site/dev/common.sh

-Original file line number
+Diff line change
@@ Expand Up / @@ -234,6 +234,21 @@ pull_versioned_docs () { @@
       create_nightly
     }
+    # Sets up local worktrees for the documentation and performs operations related to different versions.
+    pull_local_docs () {
+      echo " --> pull local docs (fast local mode)"
+      mkdir -p docs/docs
+      mkdir -p docs/javadoc
+      # Retrieve the latest version of documentation for processing
+      local latest_version=$(get_latest_version)
+      echo "Latest version is: ${latest_version}"
+      # Only create the 'nightly' version in local mode, skip 'latest' for speed
+      create_nightly
+    }
     # Cleans up artifacts and temporary files generated during documentation management.
     clean () {
       echo " --> clean"
@@ Expand Down @@

site/dev/serve.sh

-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,6 @@ @@
     set -e
-    ./dev/setup_env.sh
+    ./dev/setup_env.sh "$1"
     mkdocs serve --dirty --watch .

site/dev/setup_env.sh

-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,10 @@ clean @@
     install_deps
-    pull_versioned_docs
+    if [ "$1" == "--local" ]; then
+      pull_local_docs
+    else
+      pull_versioned_docs
+    fi
     git show "${REMOTE}/main:../.asf.yaml" > docs/.asf.yaml

Docs: improve local editing experience #13664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

yeswanth-s1th wants to merge 19 commits into apache:main from yeswanth-s1th:fix-issue-13661

-Original file line number
+Diff line change
@@ Expand Up / @@ -21,6 +21,10 @@ help: # Show help for each of the Makefile recipes. @@
     serve: # Clean, build, and run the docs site locally.
     	dev/serve.sh
+    .PHONY: serve-local
+    serve-local: # Clean, build, and run the docs site locally using local docs.
+    	dev/serve.sh --local
     .PHONY: build
     build: # Clean and build the docs site locally.
     	dev/build.sh
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -234,6 +234,21 @@ pull_versioned_docs () { @@
       create_nightly
     }
+    # Sets up local worktrees for the documentation and performs operations related to different versions.
+    pull_local_docs () {
+      echo " --> pull local docs (fast local mode)"
+      mkdir -p docs/docs
+      mkdir -p docs/javadoc
+      # Retrieve the latest version of documentation for processing
+      local latest_version=$(get_latest_version)
+      echo "Latest version is: ${latest_version}"
+      # Only create the 'nightly' version in local mode, skip 'latest' for speed
+      create_nightly
+    }
     # Cleans up artifacts and temporary files generated during documentation management.
     clean () {
       echo " --> clean"
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,6 @@ @@
     set -e
-    ./dev/setup_env.sh
+    ./dev/setup_env.sh "$1"
     mkdocs serve --dirty --watch .

-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,10 @@ clean @@
     install_deps
-    pull_versioned_docs
+    if [ "$1" == "--local" ]; then
+      pull_local_docs
+    else
+      pull_versioned_docs
+    fi
     git show "${REMOTE}/main:../.asf.yaml" > docs/.asf.yaml

Provide feedback