Fix here links, list numbering, and alert formatting for web docs (#457)

NVIDIA · Feb 19, 2025 · 8953148 · 8953148
1 parent 23afddb
commit 8953148
Show file tree

Hide file tree

Showing 11 changed files with 133 additions and 123 deletions.
diff --git a/README.md b/README.md
@@ -226,7 +226,7 @@ In the below examples, we are doing text, chart, table, and image extraction:
 #### In Python
 
 > [!NOTE]
-> You can find more examples [here](client/client_examples/examples/).
+> You can find more examples in [the client examples folder](client/client_examples/examples/).
 
 
 ```python
@@ -284,7 +284,7 @@ print(f"Got {len(result)} results")
 #### Using the `nv-ingest-cli`
 
 > [!NOTE]
-> You can find more examples [here](client/client_examples/examples/).
+> You can find more examples in [the client examples folder](client/client_examples/examples/).
 
 ```shell
 nv-ingest-cli \
@@ -345,7 +345,7 @@ multimodal_test.pdf.metadata.json
 processed_docs/text:
 multimodal_test.pdf.metadata.json
 ```
-You can view the full JSON extracts and the metadata definitions [here](/docs/docs/user-guide/developer-guide/content-metadata.md).
+For the full metadata definitions, refer to [Content Metadata](/docs/docs/user-guide/developer-guide/content-metadata.md).
 
 #### We also provide a script for inspecting [extracted images](src/util/image_viewer.py)
 

diff --git a/client/README.md b/client/README.md
@@ -432,4 +432,4 @@ Here are the options provided by the CLI, explained:
 
 ## Examples
 
-You can find a notebook with examples using the client [here](client_examples/examples/cli_client_usage.ipynb).
+You can find a notebook with examples that use the CLI client in [the client examples folder](client/client_examples/examples/).
diff --git a/deploy/pdf-blueprint.ipynb b/deploy/pdf-blueprint.ipynb
@@ -66,7 +66,7 @@
    "source": [
     "## Clone the repository and log into Docker\n",
     "\n",
-    "In order to spin up this blueprint, you will need an NGC api key. Talk to your NVIDIA rep or apply for access [here](https://developer.nvidia.com/nemo-microservices). After you get your API key, paste it below where we run `export NGC_API_KEY=`."
+    "In order to spin up this blueprint, you will need an NGC api key. Talk to your NVIDIA rep or apply for access at [https://developer.nvidia.com/nemo-microservices](https://developer.nvidia.com/nemo-microservices). After you get your API key, paste it below where we run `export NGC_API_KEY=`."
    ]
   },
   {

diff --git a/docs/docs/user-guide/developer-guide/kubernetes-dev.md b/docs/docs/user-guide/developer-guide/kubernetes-dev.md
@@ -4,7 +4,9 @@ Developing directly on Kubernetes gives us more confidence that end-user deploym
 
 This page describes how to use Kubernetes generally and how to deploy nv-ingest on a local Kubernetes cluster.
 
-> **NOTE:** _Unless otherwise noted, all commands below should be run from the root of this repo._
+!!! warning 
+
+    Unless otherwise noted, all commands below should be run from the root of this repo.
 
 ## Kubernetes Cluster
 

diff --git a/docs/docs/user-guide/index.md b/docs/docs/user-guide/index.md
@@ -9,11 +9,9 @@ extracted into discrete content, and further contextualized through optical char
 From there, NVIDIA-Ingest can optionally manage computation of embeddings for the extracted content, 
 and optionally manage storing into a vector database [Milvus](https://milvus.io/).
 
-> [!Note]
-> Cached and Deplot are deprecated. 
-> Instead, docker-compose now uses a beta version of the yolox-graphic-elements container. 
-> With this change, you should now be able to run nv-ingest on a single 80GB A100 or H100 GPU.
-> If you want to use the old pipeline, with Cached and Deplot, use the [nv-ingest 24.12.1 release](https://github.com/NVIDIA/nv-ingest/tree/24.12.1).
+!!! note
+
+    Cached and Deplot are deprecated. Instead, docker-compose now uses a beta version of the yolox-graphic-elements container. With this change, you should now be able to run nv-ingest on a single 80GB A100 or H100 GPU. If you want to use the old pipeline, with Cached and Deplot, use the [nv-ingest 24.12.1 release](https://github.com/NVIDIA/nv-ingest/tree/24.12.1).
 
 
 ## What NVIDIA-Ingest Is ✔️

diff --git a/docs/docs/user-guide/prerequisites.md b/docs/docs/user-guide/prerequisites.md
@@ -17,5 +17,7 @@ Before you begin using NVIDIA-Ingest, ensure the following hardware and software
 - [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) (NVIDIA Driver >= `535`, CUDA >= `12.2`)
 - [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
 
-> [!Note]
-> You install Python later. NVIDIA-Ingest only supports [Python version 3.10](https://www.python.org/downloads/release/python-3100/).
+
+!!! note
+
+    You install Python later. NVIDIA-Ingest only supports [Python version 3.10](https://www.python.org/downloads/release/python-3100/).
diff --git a/docs/docs/user-guide/quickstart-guide.md b/docs/docs/user-guide/quickstart-guide.md
diff --git a/examples/langchain_multimodal_rag.ipynb b/examples/langchain_multimodal_rag.ipynb
@@ -21,7 +21,7 @@
    "id": "c6905d11-0ec3-43c8-961b-24cb52e36bfe",
    "metadata": {},
    "source": [
-    "**Note:** In order to run this notebook, you'll need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You'll also need to have the NV-Ingest python client installed as demonstrated [here](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
+    "**Note:** In order to run this notebook, you need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You also need to install the NV-Ingest python client installed as explained in [Step 2: Instal Python dependencies](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
    ]
   },
   {

diff --git a/examples/llama_index_multimodal_rag.ipynb b/examples/llama_index_multimodal_rag.ipynb
@@ -21,7 +21,7 @@
    "id": "c65edc4b-2084-47c9-a837-733264201802",
    "metadata": {},
    "source": [
-    "**Note:** In order to run this notebook, you'll need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You'll also need to have the NV-Ingest python client installed as demonstrated [here](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
+    "**Note:** In order to run this notebook, you need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You also need to install the NV-Ingest python client installed as explained in [Step 2: Instal Python dependencies](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
    ]
   },
   {

diff --git a/examples/store_and_display_images.ipynb b/examples/store_and_display_images.ipynb
@@ -21,7 +21,7 @@
    "id": "2a598d15-adf0-406a-95c6-6d49c0939508",
    "metadata": {},
    "source": [
-    "**Note:** In order to run this notebook, you'll need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You'll also need to have the NV-Ingest python client installed as demonstrated [here](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
+    "**Note:** In order to run this notebook, you need to have the NV-Ingest microservice running along with all of the other included microservices. To do this, make sure all of the services are uncommented in the file: [docker-compose.yaml](https://github.com/NVIDIA/nv-ingest/blob/main/docker-compose.yaml) and follow the [quickstart guide](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart) to start everything up. You also need to install the NV-Ingest python client installed as explained in [Step 2: Instal Python dependencies](https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#step-2-installing-python-dependencies)."
    ]
   },
   {

diff --git a/helm/README.md b/helm/README.md
@@ -73,7 +73,7 @@ kubectl create -n ${NAMESPACE} secret generic ngc-api --from-literal=NGC_API_KEY
 
 Alternatively, you can also use an External Secret Store like Vault, the name of the secret name expected for the NGC API is `ngc-api` and the secret name expected for NVCR is `nvcrimagepullsecret`.
 
-In this case, make sure to remove the following from your helm commmand:
+In this case, make sure to remove the following from your helm command:
 
 ```bash
     --set imagePullSecret.create=true \
@@ -84,7 +84,7 @@ In this case, make sure to remove the following from your helm commmand:
 
 ### Minikube Setup
 
-The PVC setup for minikube requires a little bit more configuraiton. Please follow the steps below if you are using minikube.
+The PVC setup for minikube requires a little bit more configuration. Please follow the steps below if you are using minikube.
 
 ```bash
 minikube start --driver docker --container-runtime docker --gpus all --nodes 3
@@ -103,7 +103,8 @@ NV-Ingest uses a HTTP/Rest based submission method. By default the Rest service
 > [!TIP]
 > This means that the `nv-ingest-cli` no longer uses a Redis client so users must use the appropriate version to ensure the client is not still trying to use the RedisClient.
 
-First, build `nv-ingest-cli` from the source to ensure you have the latest code. More information is provided [here](https://github.com/NVIDIA/nv-ingest/tree/main/client).
+First, build `nv-ingest-cli` from the source to ensure you have the latest code.
+For more information, refer to [NV-Ingest-Client](https://github.com/NVIDIA/nv-ingest/tree/main/client).
 
 ```bash
 # Just to be cautious we remove any existing installation
@@ -119,7 +120,7 @@ pip install that wheel made above
 #### Rest Endpoint Ingress
 
 It is recommended that the end user provide a mechanism for [`Ingress`](https://kubernetes.io/docs/concepts/services-networking/ingress/) for the NV-Ingest pod.
-You can test outside of your Kuberenetes cluster by [port-forwarding](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/) the NV-Ingest pod to your local environment.
+You can test outside of your Kubernetes cluster by [port-forwarding](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/) the NV-Ingest pod to your local environment.
 
 Example:
 
@@ -177,7 +178,7 @@ You can also use NV-Ingest's Python client API to interact with the service runn
 | `affinity`                          | [default: {}] Affinity settings for deployment.                                                                  | `{}`    |
 | `nodeSelector`                      | Sets node selectors for the NIM -- for example `nvidia.com/gpu.present: "true"`                                  | `{}`    |
 | `logLevel`                          | Log level of NV-Ingest service. Possible values of the variable are TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL. | `DEBUG` |
-| `extraEnvVarsCM`                    | [default: ""] A Config map holding Environment variables to include in the NV-Ingest containerextraEnvVarsCM: ""   | `""`    |
+| `extraEnvVarsCM`                    | [default: ""] A Config map holding Environment variables to include in the NV-Ingest container                     | `""`    |
 | `extraEnvVarsSecret`                | [default: ""] A K8S Secret to map to Environment variables to include in the NV-Ingest container                   | `""`    |
 | `fullnameOverride`                  | [default: ""] A name to force the fullname of the NV-Ingest container to have, defaults to the Helm Release Name  | `""`    |
 | `nameOverride`                      | [default: ""] A name to base the objects created by this helm chart                                              | `""`    |
Original file line number	Diff line number	Diff line change
Expand Up		@@ -432,4 +432,4 @@ Here are the options provided by the CLI, explained:

		## Examples

		You can find a notebook with examples using the client [here](client_examples/examples/cli_client_usage.ipynb).
		You can find a notebook with examples that use the CLI client in [the client examples folder](client/client_examples/examples/).