Clean docs (#16)

* Remove theme * Add README to documentation folder
oracle-samples · Sep 20, 2024 · 706bf7a · 706bf7a
1 parent 6f57920
commit 706bf7a
Show file tree

Hide file tree

Showing 279 changed files with 165 additions and 3,375 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -47,6 +47,10 @@ jobs:
         with:
           submodules: recursive
           fetch-depth: 0
+      - name: Download Geekdocs Theme
+        run: |
+          mkdir -p docs/themes/hugo-geekdoc \
+          && curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C docs/themes/hugo-geekdoc/ --strip-components=1
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,7 +1,8 @@
-# Generated files by hugo
+##############################################################################
+# Documentation Specific
+##############################################################################
+/themes/
 /public/
-/resources/_gen/
-/assets/jsconfig.json
 hugo_stats.json
 
 # Temporary lock file while building

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,22 @@
+# Oracle AI Microservices Sandbox - Documentation
+
+## Description
+
+This directory contains the documentation for the the [**Oracle AI Microservices Sandbox**](https://github.com/oracle-samples/oaim-sandbox).
+
+## Getting Started - Documentation
+
+The **Oracle AI Microservices Sandbox** documentation is powered by [Hugo](https://gohugo.io/) using the [GeekDocs](https://geekdocs.de/) theme.
+
+To contribute to the documentation, install [Hugo](https://gohugo.io/installation/). Installation instructions vary per Operating System.
+
+From the `docs` directory:
+
+1. Download the [GeekDocs](https://geekdocs.de/) theme
+   ```bash
+   mkdir -p themes/hugo-geekdoc/
+   curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
+   ```
+1. Start Hugo: `hugo serve`
+
+This will serve the documentation on `http://localhost:1313/oaim-sandbox/` for review.
diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md
@@ -3,3 +3,8 @@ title = '{{ replace .File.ContentBaseName "-" " " | title }}'
 date = {{ .Date }}
 draft = true
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
diff --git a/docs/content/_index.md b/docs/content/_index.md
@@ -7,6 +7,11 @@ draft = false
 geekdocBreadcrumb = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
 Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
 

diff --git a/docs/content/chatbot/_index.md b/docs/content/chatbot/_index.md
@@ -3,5 +3,11 @@ title = 'Chatbot'
 date = 2024-09-11T07:35:03Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md
@@ -7,6 +7,12 @@ draft = false
   src = "images/db_config.png"
   title = "Database Configuration"
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
 Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
 
@@ -38,6 +44,6 @@ For more information on configuring OCI, please read about [OCI Configuration](o
 
 ## Import Settings 💾
 
-Once you have configured the **Oracle AI Microservices Sandbox**, you can export the settings and import them after a restart or new deployment.  
+Once you have configured the **Oracle AI Microservices Sandbox**, you can export the settings and import them after a restart or new deployment.
 
 For more information on importing (and exporting) settings, please read about [Import Settings](import_settings/).
diff --git a/docs/content/configuration/db_config.md b/docs/content/configuration/db_config.md
@@ -1,10 +1,15 @@
----
-title: "Database Configuration"
-date: 2024-09-10T13:57:37Z
-draft: false
----
++++
+title = "Database Configuration"
+date = 2024-09-10T13:57:37Z
+draft = false
++++
 
-To use the Retrieval-Augmented Generation (RAG) functionality of the Sandbox, you will need to setup/enable an [embedding model](model_config) and have access to an **Oracle Database 23ai**. Both the [Always Free Oracle Autonomous Database Serverless (ADB-S)](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-always-free.html) and the [Oracle Database 23ai Free](https://www.oracle.com/uk/database/free/get-started/) are supported. They are a great, no-cost, way to get up and running quickly.
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
+To use the Retrieval-Augmented Generation (RAG) functionality of the Sandbox, you will need to setup/enable an [embedding model](../model_config) and have access to an **Oracle Database 23ai**. Both the [Always Free Oracle Autonomous Database Serverless (ADB-S)](https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-always-free.html) and the [Oracle Database 23ai Free](https://www.oracle.com/uk/database/free/get-started/) are supported. They are a great, no-cost, way to get up and running quickly.
 
 ## Configuration
 
@@ -47,8 +52,8 @@ export DB_WALLET_PASSWORD=MYCOMPLEXWALLETSECRET
 
 For mTLS database connectivity or to specify a TNS alias instead of a full connect string, you can use the contents of a `TNS_ADMIN` directory.
 
-{{< hint type=[info] icon=gdoc_info_outline title="Same... but Different" >}}
-If using and ADB-S wallet, unzip the contents into the `TNS_ADMIN` directory.
+{{< hint type=[info] icon=gdoc_info_outline title="Unzip Wallet" >}}
+If using and ADB-S wallet, unzip the contents into the `TNS_ADMIN` directory. The `.zip` file will not be recognized.
 {{< /hint >}}
 
 ### Bare-Metal Installation
@@ -59,7 +64,7 @@ For bare-metal installations, set the `TNS_ADMIN` environment variable, or copy
 
 For container installations, there are a couple of ways to include the contents of your `TNS_ADMIN` in the image:
 
-- Before building the image, copy the contents of your `TNS_ADMIN` to `app/src/tns_admin`.  This will include your `TNS_ADMIN` as part of the image.
+- Before building the image, copy the contents of your `TNS_ADMIN` to `app/src/tns_admin`. This will include your `TNS_ADMIN` as part of the image.
 - Mount your `TNS_ADMIN` directory into the container on startup, for example: `podman run -p 8501:8501 -v $TNS_ADMIN:/app/tns_admin -it --rm oaim-sandbox`
 - Copy the `TNS_ADMIN` directory into an existing running container, for example: `podman cp $TNS_ADMIN /app/tns_admin oaim-sandbox`
 

diff --git a/docs/content/configuration/import_settings.md b/docs/content/configuration/import_settings.md
@@ -3,5 +3,11 @@ title = 'Import Settings'
 date = 2024-09-11T07:30:48Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/configuration/model_config.md b/docs/content/configuration/model_config.md
@@ -4,6 +4,11 @@ date = 2024-09-11T07:30:34Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 ## Supported Models
 
 At a minimum, a Large _Language Model_ (LLM) must be configured in **Oracle AI Microservices Sandbox** for basic functionality. For Retrieval-Augmented Generation (**RAG**), an _Embedding Model_ will also need to be configured.

diff --git a/docs/content/configuration/oci_config.md b/docs/content/configuration/oci_config.md
@@ -3,5 +3,11 @@ title = 'OCI Configuration'
 date = 2024-09-11T07:30:42Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/help/_index.md b/docs/content/help/_index.md
@@ -3,5 +3,11 @@ title = 'Get Help'
 date = 2024-09-11T07:36:44Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/help/troubleshooting/_index.md b/docs/content/help/troubleshooting/_index.md
@@ -3,5 +3,11 @@ title = 'Troubleshooting'
 date = 2024-09-11T07:36:55Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/infrastructure/_index.md b/docs/content/infrastructure/_index.md
@@ -4,5 +4,10 @@ date = 2024-09-10T10:48:24Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/test_framework/_index.md b/docs/content/test_framework/_index.md
@@ -3,5 +3,11 @@ title = 'Test Framework'
 date = 2024-09-11T07:34:45Z
 draft = false
 +++
+
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/tools/_index.md b/docs/content/tools/_index.md
@@ -4,5 +4,10 @@ date = 2024-09-11T07:31:52Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/tools/prompt_eng.md b/docs/content/tools/prompt_eng.md
@@ -4,5 +4,10 @@ date = 2024-09-11T07:31:52Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/tools/split_embed.md b/docs/content/tools/split_embed.md
@@ -4,5 +4,10 @@ date = 2024-09-11T07:31:26Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 {{< hint type=[warning] icon=gdoc_fire title="10-Sept-2024: Documentation In-Progress..." >}}
-Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
+Thank you for your patience as we work on updating the documentation. Please check back soon for the latest updates.{{< /hint >}}
diff --git a/docs/content/walkthrough/_index.md b/docs/content/walkthrough/_index.md
@@ -4,6 +4,11 @@ date = 2024-09-11T14:33:30Z
 draft = false
 +++
 
+<!--
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+
 This walkthrough will guide you through a basic installation of the **Oracle AI Microservices Sandbox** (the **Sandbox**). It will allow you to experiment with GenAI, using Retrieval-Augmented Generation (**RAG**) with Oracle Database 23ai at the core.
 
 By the end of the walkthrough you will be familiar with:

diff --git a/docs/data/menu/extra.yaml b/docs/data/menu/extra.yaml
@@ -1,6 +1,8 @@
+## Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
 ---
 header:
   - name: GitHub
     ref: https://github.com/oracle-samples/oaim-sandbox
     icon: gdoc_github
-    external: true
+    external: true
diff --git a/docs/data/menu/main.yaml b/docs/data/menu/main.yaml
@@ -1,3 +1,5 @@
+## Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
 main:
   - name: Getting Started
     ref: "/"
@@ -17,7 +19,7 @@ main:
           - name: "Prompts 🎤"
             ref: "/tools/prompt_eng.md"
           - name: "Split/Embed 📚"
-            ref: "/tools/split_embed.md"          
+            ref: "/tools/split_embed.md"
       - name: "Configuration"
         ref: "/configuration"
         sub:

diff --git a/docs/hugo.toml b/docs/hugo.toml
@@ -1,3 +1,6 @@
+## Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+
 baseURL = 'https://oracle-samples.github.io/oaim-sandbox'
 languageCode = 'en-us'
 title = 'AI Microservices Sandbox'

diff --git a/docs/i18n/en.yaml b/docs/i18n/en.yaml
@@ -1,3 +1,5 @@
+## Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+## Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
 ---
 edit_page: Edit page
 

diff --git a/docs/layouts/shortcodes/q_icon.html b/docs/layouts/shortcodes/q_icon.html
@@ -1,5 +1,20 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="icon">
+<!-- 
+Copyright (c) 2023, 2024, Oracle and/or its affiliates.
+Licensed under the Universal Permissive License v1.0 as shown at http://oss.oracle.com/licenses/upl.
+-->
+<svg
+  xmlns="http://www.w3.org/2000/svg"
+  width="16"
+  height="16"
+  viewBox="0 0 24 24"
+  fill="none"
+  stroke="currentColor"
+  stroke-width="2"
+  stroke-linecap="round"
+  stroke-linejoin="round"
+  class="icon"
+>
   <circle cx="12" cy="12" r="10"></circle>
   <path d="M9.09 9a3 3 0 0 1 5.83 1c0 2-3 3-3 3"></path>
   <line x1="12" y1="17" x2="12.01" y2="17"></line>
-</svg>
+</svg>
diff --git a/docs/themes/hugo-geekdoc/.nvmrc b/docs/themes/hugo-geekdoc/.nvmrc
diff --git a/docs/themes/hugo-geekdoc/LICENSE b/docs/themes/hugo-geekdoc/LICENSE