[DOC] add custom 404 page and fix some document issue [skip ci] (#10309)

* add custom 404 page Signed-off-by: liyuan <[email protected]> * Update .github/404.html Co-authored-by: Gera Shegalov <[email protected]> * test markdownlink checker Signed-off-by: liyuan <[email protected]> * check all links Signed-off-by: liyuan <[email protected]> * fix all dead links Signed-off-by: liyuan <[email protected]> * revert markdown link checker config files after fix all dead links Signed-off-by: liyuan <[email protected]> * enable all links checking as discussed in #10322 Signed-off-by: liyuan <[email protected]> * we already support zstd orc and parquet write, fix #10365 Signed-off-by: liyuan <[email protected]> --------- Signed-off-by: liyuan <[email protected]> Co-authored-by: Gera Shegalov <[email protected]>
NVIDIA · Feb 6, 2024 · 6c01e1b · 6c01e1b
1 parent b75b161
commit 6c01e1b
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 8 deletions.
diff --git a/.github/404.html b/.github/404.html
@@ -0,0 +1,26 @@
+---
+layout: default
+permalink: /404.html
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+    <p> The requested page could not be found. 
+        If you are looking for documentation please navigate to the <a href="https://docs.nvidia.com/spark-rapids/user-guide/latest/index.html">User Guide</a> for more information</p>
+</div>
diff --git a/.github/workflows/markdown-links-check.yml b/.github/workflows/markdown-links-check.yml
@@ -30,7 +30,6 @@ jobs:
       with:
         max-depth: -1
         use-verbose-mode: 'yes'
-        check-modified-files-only: 'yes'
         config-file: '.github/workflows/markdown-links-check/markdown-links-check-config.json'
         base-branch: 'gh-pages'
 

diff --git a/docs/additional-functionality/rapids-udfs.md b/docs/additional-functionality/rapids-udfs.md
@@ -11,8 +11,8 @@ implementation alongside the CPU implementation, enabling the
 RAPIDS Accelerator to perform the user-defined operation on the GPU.
 
 Note that there are other potential solutions to performing user-defined
-operations on the GPU. See the
-[Frequently Asked Questions entry](../FAQ.md#how-can-i-run-custom-expressionsudfs-on-the-gpu)
+operations on the GPU. See the 
+[Frequently Asked Questions entry](https://docs.nvidia.com/spark-rapids/user-guide/latest/faq.html#how-can-i-run-custom-expressions-udfs-on-the-gpu)
 on UDFs for more details.
 
 ## UDF Obstacles To Query Acceleration
@@ -52,7 +52,7 @@ Other forms of Spark UDFs are not supported, such as:
 
 For supported UDFs, the RAPIDS Accelerator will detect a GPU implementation
 if the UDF class implements the
-[RapidsUDF](../../sql-plugin/src/main/java/com/nvidia/spark/RapidsUDF.java)
+[RapidsUDF](../../sql-plugin-api/src/main/java/com/nvidia/spark/RapidsUDF.java)
 interface. Unlike the CPU UDF which processes data one row at a time, the
 GPU version processes a columnar batch of rows. This reduces invocation
 overhead and enables parallel processing of the data by the GPU.
@@ -219,7 +219,7 @@ The following configuration settings are also relevant for GPU scheduling for Pa
     --conf spark.rapids.python.memory.gpu.allocFraction=0.1 \
     --conf spark.rapids.python.memory.gpu.maxAllocFraction= 0.2 \
     ```
-    Similar to the [RMM pooling for JVM](../tuning-guide.md#pooled-memory) settings like
+    Similar to the [RMM pooling for JVM](https://docs.nvidia.com/spark-rapids/user-guide/latest/tuning-guide.html#pinned-memory) settings like
     `spark.rapids.memory.gpu.allocFraction` and `spark.rapids.memory.gpu.maxAllocFraction` except
     these specify the GPU pool size for the _Python processes_. Half of the GPU _available_ memory
     will be used by default if it is not specified.

diff --git a/docs/compatibility.md b/docs/compatibility.md
@@ -245,7 +245,9 @@ to work for dates after the epoch as described
 [here](https://github.com/NVIDIA/spark-rapids/issues/140).
 
 The plugin supports reading `uncompressed`, `snappy`, `zlib` and `zstd` ORC files and writing
- `uncompressed` and `snappy` ORC files.  At this point, the plugin does not have the ability to fall
+ `uncompressed`, `snappy` and `zstd` ORC files.  At this point, the plugin does not have the 
+ability to 
+fall
  back to the CPU when reading an unsupported compression format, and will error out in that case.
 
 ### Push Down Aggregates for ORC
@@ -307,7 +309,8 @@ When writing `spark.sql.legacy.parquet.datetimeRebaseModeInWrite` is currently i
 [here](https://github.com/NVIDIA/spark-rapids/issues/144).
 
 The plugin supports reading `uncompressed`, `snappy`, `gzip` and `zstd` Parquet files and writing
-`uncompressed` and `snappy` Parquet files.  At this point, the plugin does not have the ability to
+`uncompressed`, `snappy` and `zstd` Parquet files.  At this point, the plugin does not have the 
+ability to
 fall back to the CPU when reading an unsupported compression format, and will error out in that
 case.
 

diff --git a/docs/dev/microk8s.md b/docs/dev/microk8s.md
@@ -91,7 +91,7 @@ This token can then be specified in the `spark-submit` command with
 
 ## Building and exporting Docker images
 
-Follow the instructions in [Getting Started with RAPIDS and Kubernetes](../get-started/getting-started-kubernetes.md)
+Follow the instructions in [Getting Started with RAPIDS and Kubernetes](https://docs.nvidia.com/spark-rapids/user-guide/latest/getting-started/kubernetes.html)
 to create Docker images containing Spark and the RAPIDS Accelerator for Apache Spark.
 
 Note that an additional step is required to export the Docker images from the host and import them into the Microk8s