Add HCD and DSE 6.9 examples to nav (#585)

eric-schneider · mendonk · web-flow · commit 8c8014da1b09 · 2024-07-12T17:35:59.000-04:00
* Add HCD and DSE 6.9 examples to nav

* Add Atlas extension to local build

* Update external links to comply with style guide

* add-example-links

* move-prereqs-and-add-to-nav

---------

Co-authored-by: Mendon Kissling &lt;59585235+mendonk@users.noreply.github.com&gt;
diff --git a/docs/local-preview-playbook.yml b/docs/local-preview-playbook.yml
@@ -57,6 +57,9 @@ asciidoc:
     astra_ui: 'Astra Portal'
     support_url: 'https://support.datastax.com'
     glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
+    # Antora Atlas
+    primary-site-url: https://docs.datastax.com/en
+    primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json
 
 urls:
   latest_version_segment_strategy: redirect:from
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -41,6 +41,9 @@
 
 .RAGStack Examples
 * xref:examples:index.adoc[]
+* xref:examples:prerequisites.adoc[]
+* xref:examples:hcd.adoc[]
+* xref:examples:dse-69.adoc[]
 * xref:examples:colbert.adoc[]
 * xref:examples:knowledge-graph.adoc[]
 * xref:examples:knowledge-store.adoc[]
diff --git a/docs/modules/ROOT/pages/changelog.adoc b/docs/modules/ROOT/pages/changelog.adoc
@@ -4,9 +4,9 @@ The RAGStack changelog provides information about dependency versions for each r
 
 For more, see:
 
-* https://github.com/datastax/ragstack-ai/releases[GitHub releases^]
+* https://github.com/datastax/ragstack-ai/releases[GitHub releases]
 
-* https://pypi.org/project/ragstack-ai/[PyPI^]
+* https://pypi.org/project/ragstack-ai/[PyPI]
 
 
 == `ragstack-ai`@1.0.7 (2024-05-31)
@@ -49,7 +49,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.7/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.7/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.3
@@ -110,7 +110,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.6/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.6/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.0
@@ -222,7 +222,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.5/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.5/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.0
@@ -334,7 +334,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.4/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.4/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.0
@@ -446,7 +446,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.3/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.3/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.0
@@ -558,7 +558,7 @@ For more, see:
 | <0.2.0,>=0.1.4
 
 | langchain
-| https://datastax.github.io/ragstack-ai/api_reference/1.0.2/langchain[==0.1.19]{external-link-icon}
+| https://datastax.github.io/ragstack-ai/api_reference/1.0.2/langchain[==0.1.19]
 
 | langchain-astradb
 | ==0.3.0
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -34,7 +34,7 @@ If you are already using an open-source library that is part of {product} in you
 --
 {company} has been busy helping our customers through the pains of RAG implementation, so the {product} components we've selected have withstood production workloads and stringent testing by our engineering teams for performance, compatibility, and security.
 
-* {product} leverages the https://python.langchain.com/docs/get_started/introduction[LangChain^] ecosystem and is fully compatible with https://docs.smith.langchain.com/[LangSmith^] for monitoring your AI deployments.
+* {product} leverages the https://python.langchain.com/docs/get_started/introduction[LangChain] ecosystem and is fully compatible with https://docs.smith.langchain.com/[LangSmith] for monitoring your AI deployments.
 
 * The https://docs.datastax.com/en/astra/astra-db-vector/get-started/quickstart.html[{db-serverless}] database provides the best performance and scalability for RAG applications, in addition to being particularly well-suited to RAG workloads like question answering, semantic search, and semantic caching.
 --
diff --git a/docs/modules/ROOT/pages/luna-for-ragstack.adoc b/docs/modules/ROOT/pages/luna-for-ragstack.adoc
@@ -1,20 +1,20 @@
 = Luna for RAGStack
 :keywords: Luna, support, expertise, RAGStack, GenAI, Retrieval-Augmented Generation, RAG
 
-Luna is a subscription to support and expertise at DataStax. It allows you to enjoy all the benefits of the components we support, with the peace of mind knowing you have direct access to the team that authors the majority of the code and supports some of the world's largest deployments. 
+Luna is a subscription to support and expertise at DataStax. It allows you to enjoy all the benefits of the components we support, with the peace of mind knowing you have direct access to the team that authors the majority of the code and supports some of the world's largest deployments.
 
-Adding external components to a GenAI platform to support development and production environments is complex. https://www.datastax.com/products/luna-ragstack[Luna for RAGStack] gives you direct access to experts who specialize in Retrieval-Augmented Generation (RAG) applications. 
+Adding external components to a GenAI platform to support development and production environments is complex. https://www.datastax.com/products/luna-ragstack[Luna for RAGStack] gives you direct access to experts who specialize in Retrieval-Augmented Generation (RAG) applications.
 
 RAGStack includes a RAG implementation, giving you a comprehensive GenAI stack that leverages xref:examples:index.adoc#langchain-astra[LangChain and Astra DB Serverless], xref:examples:index.adoc#llama-astra[LlamaIndex and Astra DB Serverless], and more. RAGStack supports integration with Vertex AI, Gemini, Bedrock, and NVIDIA NeMo embedding microservices, offering a wider array of tested, compatible embeddings and models for your applications.
 
 To learn more, see the http://www.datastax.com/blog/empowering-enterprise-genai-announcing-luna-for-ragstack[Luna blog].
 
 == Luna for RAGStack subscription pricing
 
-Please https://www.datastax.com/contact-us[contact us^] for details about the Luna for RAGStack subscription options and pricing.
+Please https://www.datastax.com/contact-us[contact us] for details about the Luna for RAGStack subscription options and pricing.
 
 // TODO: update the pricing URL when it's ready just before the launch date.
-// See the https://www.datastax.com/products/luna[Luna packages] page.  
+// See the https://www.datastax.com/products/luna[Luna packages] page.
 
 == What's next?
 
diff --git a/docs/modules/default-architecture/pages/loading.adoc b/docs/modules/default-architecture/pages/loading.adoc
@@ -3,7 +3,7 @@
 Start with LangChain for loading your data instead of manually coding your own pipeline.
 LangChain likely already provides the functionalities you need.
 
-The examples use vector-enabled {db-serverless} database for the vector store and assume you have one available. If not, see xref:ROOT:prerequisites.adoc[].
+The examples use vector-enabled {db-serverless} database for the vector store and assume you have one available. If not, see xref:examples:prerequisites.adoc[].
 
 == Load PDF from file
 
diff --git a/docs/modules/examples/pages/dse-69.adoc b/docs/modules/examples/pages/dse-69.adoc
@@ -1,4 +1,5 @@
 = RAGStack and DataStax Enterprise (DSE) 6.9 example
+:navtitle: RAGStack with DataStax Enterprise
 
 . Pull the latest dse-server Docker image and confirm the container is in a running state.
 +
diff --git a/docs/modules/examples/pages/hcd.adoc b/docs/modules/examples/pages/hcd.adoc
@@ -1,4 +1,5 @@
-= RAGStack and Hyper Converged Database (HCD) example
+= RAGStack and Hyper-Converged Database (HCD) example
+:navtitle: RAGStack with Hyper-Converged Database
 
 . Clone the HCD example repository.
 +
diff --git a/docs/modules/examples/pages/index.adoc b/docs/modules/examples/pages/index.adoc
@@ -87,6 +87,14 @@ We're actively updating this section, so check back often!
 | Store external or proprietary data in {db-serverless} and query it to provide more up-to-date LLM responses.
 | https://colab.research.google.com/github/datastax/ragstack-ai/blob/main/examples/notebooks/RAG_with_cassio.ipynb[Open in Colab]
 | xref:rag-with-cassio.adoc[]
+
+| Use the self-managed Hyper-Converged Database (HCD) as a vector backend for your RAG application.
+|
+| xref:hcd.adoc[]
+
+| Use DataStax Enterprise as a vector backend for your RAG application.
+|
+| xref:dse-69.adoc[]
 |===
 
 
diff --git a/docs/modules/examples/pages/langchain_multimodal_gemini.adoc b/docs/modules/examples/pages/langchain_multimodal_gemini.adoc
@@ -17,15 +17,15 @@ vector database].
 DB Access Token] with Database Administrator permissions.
 * Get your {db-serverless} API Endpoint:
 ** `https://<ASTRA_DB_ID>-<ASTRA_DB_REGION>.apps.astra.datastax.com`
-* Create a https://cloud.google.com/[GCP account^] and a https://cloud.google.com/iam/docs/service-account-overview[service account^]. Download your service account's GCP credentials as a JSON file. For more on service account authorization, see the https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account[GCP documentation^].
+* Create a https://cloud.google.com/[GCP account] and a https://cloud.google.com/iam/docs/service-account-overview[service account]. Download your service account's GCP credentials as a JSON file. For more on service account authorization, see the https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account[GCP documentation].
 * Install the following dependencies:
 +
 [source,python]
 ----
 pip install google-cloud-aiplatform ragstack-ai --upgrade
 ----
 
-See the xref:ROOT:prerequisites.adoc[] page for more details.
+See the xref:examples:prerequisites.adoc[] page for more details.
 
 == Configure {db-serverless} and GCP credentials
 
diff --git a/docs/modules/examples/pages/prerequisites.adoc b/docs/modules/examples/pages/prerequisites.adoc
@@ -35,7 +35,7 @@ Automatically created if it doesn't exist.
 | GCP service account JSON
 | `your-project-name-999999-r99b99999999json`
 | Credentials for GCP usage.
-See the https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account[GCP documentation^].
+See the https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account[GCP documentation].
 
 | LlamaIndex Cloud API key
 | `llx-...`
@@ -46,4 +46,4 @@ If a notebook needs additional dependencies, we'll show you how to install them.
 
 == What's next?
 
-With your prerequisites set up, run the xref:quickstart.adoc[]!
+With your prerequisites set up, run the xref:ROOT:quickstart.adoc[]!
diff --git a/docs/modules/examples/pages/qa-with-cassio.adoc b/docs/modules/examples/pages/qa-with-cassio.adoc
@@ -51,7 +51,7 @@ from cassandra.auth import PlainTextAuthProvider
 +
 [NOTE]
 ====
-You will need a secure connect bundle and a user with access permission. For demo purposes, the "administrator" role will work fine. For more, see  xref:ROOT:prerequisites.adoc[Prerequisites].
+You will need a secure connect bundle and a user with access permission. For demo purposes, the "administrator" role will work fine. For more, see  xref:examples:prerequisites.adoc[Prerequisites].
 ====
 +
 . Initialize the environment variables.
diff --git a/docs/modules/examples/pages/rag-with-cassio.adoc b/docs/modules/examples/pages/rag-with-cassio.adoc
@@ -13,7 +13,7 @@ A solution to this problem is Retrieval Augmentated Generation (RAG). The idea b
 
 == Get started with this notebook
 
-See xref:ROOT:prerequisites.adoc[Prerequisites] for instructions on setting up your environment.
+See xref:examples:prerequisites.adoc[Prerequisites] for instructions on setting up your environment.
 
 . Install the following libraries.
 +
diff --git a/docs/modules/examples/partials/prerequisites.adoc b/docs/modules/examples/partials/prerequisites.adoc
@@ -2,7 +2,7 @@
 
 You will need an vector-enabled {db-serverless} database and an OpenAI Account.
 
-See the xref:ROOT:prerequisites.adoc[] page for more details.
+See the xref:examples:prerequisites.adoc[] page for more details.
 
 . Create an vector-enabled {db-serverless} database.
 . Create an OpenAI account
diff --git a/docs/modules/langflow/pages/index.adoc b/docs/modules/langflow/pages/index.adoc
@@ -1,6 +1,6 @@
 = Langflow
 
-https://docs.langflow.org[Langflow^] is a visual way to build, iterate, and deploy AI applications. Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions.
+https://docs.langflow.org[Langflow] is a visual way to build, iterate, and deploy AI applications. Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions.
 
 A single Langflow "flow" could contain multiple Langchain chat components, a Llama language model, an Astra vector store, and a Redis cache. You can build any AI flow you can think of with Langflow, but how can you be confident that these components are up-to-date and compatible with your project?
 
diff --git a/docs/modules/ragstack-ts/pages/changelog.adoc b/docs/modules/ragstack-ts/pages/changelog.adoc
@@ -4,9 +4,9 @@ The RAGStack changelog provides information about new features, bug fixes, depen
 
 For more, see:
 
-* https://github.com/datastax/ragstack-ai-ts/releases[GitHub releases^]{external-link-icon}
+* https://github.com/datastax/ragstack-ai-ts/releases[GitHub releases]
 
-* https://www.npmjs.com/package/@datastax/ragstack-ai[NPM^]{external-link-icon}
+* https://www.npmjs.com/package/@datastax/ragstack-ai[NPM]
 
 
 == 1.0.0
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= RAGStack and DataStax Enterprise (DSE) 6.9 example`
	`2`	`+:navtitle: RAGStack with DataStax Enterprise`
`2`	`3`
`3`	`4`	`. Pull the latest dse-server Docker image and confirm the container is in a running state.`
`4`	`5`	`+`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-= RAGStack and Hyper Converged Database (HCD) example`
	`1`	`+= RAGStack and Hyper-Converged Database (HCD) example`
	`2`	`+:navtitle: RAGStack with Hyper-Converged Database`
`2`	`3`
`3`	`4`	`. Clone the HCD example repository.`
`4`	`5`	`+`