Group Manual > Core topics

Author: lukasz-antoniak

.github/workflows/publish-docs-gp-pages.yml

@@ -47,15 +47,15 @@ jobs:
           chmod +x ./build-doc.sh
           ./build-doc.sh
 
-      # 5. Checkout gh-pages branch
+      # 5. Checkout doc-view branch
       - name: Checkout GH pages branch
         uses: actions/checkout@v4
         with:
-          ref: gh-pages
-          path: gh-pages
+          ref: doc-view
+          path: doc-view
 
       - name: Copy and version documentation
-        working-directory: gh-pages
+        working-directory: doc-view
         run: |
           git config --global user.email "gha@cassandra.apache.org"
           git config --global user.name "GHA for Apache Cassandra Website"
@@ -66,7 +66,7 @@ jobs:
           # update links to contain version prefix
           mike deploy --update-aliases $release_version
           # copy documentation web page folder
-          cd ../gh-pages
+          cd ../doc-view
           cp -r ../java-driver/docs ./
           rm -rf $release_version
           mv docs $release_version
@@ -85,17 +85,17 @@ jobs:
           echo "release_version=$release_version" >> "$GITHUB_ENV"
 
       - name: Commit and push documentation
-        working-directory: gh-pages
+        working-directory: doc-view
         run: |
           git config --global user.email "gha@cassandra.apache.org"
           git config --global user.name "GHA for Apache Cassandra Website"
 
           git add .
 
           if git diff --cached --quiet; then
-            echo "No changes to push to gh-pages"
+            echo "No changes to push to doc-view"
             exit 0
           fi
 
           git commit -m "Update generated docs for release ${release_version}"
-          git push origin gh-pages
+          git push origin doc-view

mkdocs.yml

@@ -40,47 +40,54 @@ nav:
       - Configuration:
         - Overview: manual/core/configuration/README.md
         - Reference: manual/core/configuration/reference/README.md
-      - Authentication: manual/core/authentication/README.md
-      - SSL: manual/core/ssl/README.md
-      - Load Balancing: manual/core/load_balancing/README.md
-      - Pooling: manual/core/pooling/README.md
-      - Reconnection: manual/core/reconnection/README.md
-      - Retries: manual/core/retries/README.md
-      - Speculative Execution: manual/core/speculative_execution/README.md
-      - Metrics: manual/core/metrics/README.md
-      - Logging: manual/core/logging/README.md
+      - Connection Management:
+        - Authentication: manual/core/authentication/README.md
+        - SSL: manual/core/ssl/README.md
+        - Pooling: manual/core/pooling/README.md
+        - Load Balancing: manual/core/load_balancing/README.md
+        - Reconnection: manual/core/reconnection/README.md
+        - Address Resolution: manual/core/address_resolution/README.md
       - Statements:
         - Overview: manual/core/statements/README.md
         - Batch: manual/core/statements/batch/README.md
         - Per Query Keyspace: manual/core/statements/per_query_keyspace/README.md
         - Prepared: manual/core/statements/prepared/README.md
         - Simple: manual/core/statements/simple/README.md
-      - Paging: manual/core/paging/README.md
-      - Async Programming: manual/core/async/README.md
-      - Reactive Streams: manual/core/reactive/README.md
-      - Custom Codecs: manual/core/custom_codecs/README.md
-      - Temporal Types: manual/core/temporal_types/README.md
-      - Tuples: manual/core/tuples/README.md
-      - UDTs: manual/core/udts/README.md
-      - Compression: manual/core/compression/README.md
-      - Address Resolution: manual/core/address_resolution/README.md
-      - Request Tracker: manual/core/request_tracker/README.md
-      - Request ID: manual/core/request_id/README.md
-      - Throttling: manual/core/throttling/README.md
-      - Tracing: manual/core/tracing/README.md
-      - Performance: manual/core/performance/README.md
+      - Query Execution:
+        - Retries: manual/core/retries/README.md
+        - Idempotence: manual/core/idempotence/README.md
+        - Speculative Execution: manual/core/speculative_execution/README.md
+        - Paging: manual/core/paging/README.md
+        - Query Timestamps: manual/core/query_timestamps/README.md
+      - Advanced Types:
+        - Custom Codecs: manual/core/custom_codecs/README.md
+        - Temporal Types: manual/core/temporal_types/README.md
+        - Tuples: manual/core/tuples/README.md
+        - UDTs: manual/core/udts/README.md
+        - Detachable Types: manual/core/detachable_types/README.md
+      - Non-blocking:
+        - Overview: manual/core/non_blocking/README.md
+        - Async Programming: manual/core/async/README.md
+        - Reactive Streams: manual/core/reactive/README.md
+      - Observability:
+        - Request Tracker: manual/core/request_tracker/README.md
+        - Request ID: manual/core/request_id/README.md
+        - Metrics: manual/core/metrics/README.md
+        - Logging: manual/core/logging/README.md
+        - Tracing: manual/core/tracing/README.md
+      - Performance:
+        - Overview: manual/core/performance/README.md
+        - Throttling: manual/core/throttling/README.md
+        - Compression: manual/core/compression/README.md
       - Metadata:
         - Overview: manual/core/metadata/README.md
         - Node: manual/core/metadata/node/README.md
         - Schema: manual/core/metadata/schema/README.md
         - Token: manual/core/metadata/token/README.md
-      - Control Connection: manual/core/control_connection/README.md
-      - Native Protocol: manual/core/native_protocol/README.md
-      - Non-blocking: manual/core/non_blocking/README.md
-      - Query Timestamps: manual/core/query_timestamps/README.md
-      - Idempotence: manual/core/idempotence/README.md
-      - Detachable Types: manual/core/detachable_types/README.md
-      - DSE:
+      - Driver Internals:
+        - Control Connection: manual/core/control_connection/README.md
+        - Native Protocol: manual/core/native_protocol/README.md
+      - DataStax DSE:
         - Overview: manual/core/dse/README.md
         - Geotypes: manual/core/dse/geotypes/README.md
         - Graph: