deploy: 594f0e2

worldbank · Jan 22, 2025 · 5b29ca7 · 5b29ca7
1 parent 538eca7
commit 5b29ca7
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 8 deletions.
diff --git a/_sources/docs/userguide/navigation.md b/_sources/docs/userguide/navigation.md
@@ -41,11 +41,43 @@ Once the plugin window is open, press the right arrow buttons highlighted in red
 >
 > - **About Page**: This page offers detailed information about the plugin, including its contributors, development background, and licensing. It highlights the open-source nature of the tool and acknowledges the organizations or individuals involved in its creation.
 
+### Setting Up the ORS Key
 
-- <p align="justify"><strong>Welcome to GEEST Page</strong>: This is the introductory page of the plugin, providing an overview of its purpose and functionality. It serves as the starting point to familiarize users with the plugin's capabilities and its relevance to geospatial analysis.</p>
+To use the GEEST plugin effectively, you need to configure the **Open Route Service (ORS)** API key. The ORS platform is used for spatial analysis workflows, and obtaining an API key is a simple and free process. Below are the steps:
 
-- <p align="justify"><strong>About Page</strong>: This page offers detailed information about the plugin, including its contributors, development background, and licensing. It highlights the open-source nature of the tool and acknowledges the organizations or individuals involved in its creation.</p>
+---
 
+#### **Step 1: Get Your API Key**
+1. Open your browser and go to the [ORS API Key Signup Page](https://openrouteservice.org/sign-up/).
+2. Register for an account or log in if you already have one.
+3. Once logged in, generate an API key by following the on-screen instructions.
+
+#### **Step 2: Paste the API Key**
+1. Copy the API key from the ORS website.
+2. Open the **GEEST ORS Setup** window in the plugin.
+3. Paste the API key into the text box provided (as shown in the screenshot below).
+
+<p align="center">
+ <img 
+    src="https://raw.githubusercontent.com/worldbank/GEEST/main/docs/images/new%20images/ORS%20setup.jpg" 
+    alt="ORS key" 
+    style="width:45%;" 
+    title="Click to enlarge" 
+    onclick="window.open(this.src, '_blank')">
+</p>
+
+#### **Step 3: Verify the Key**
+1. After pasting the API key, click the **Check my key...** button.
+2. If the key is valid, a green checkmark will appear, indicating the API key has been successfully set up.
+
+---
+
+> #### **Tips for Setting Up the ORS Key**
+> - 💡 **Tip**: Ensure you paste the exact API key without any extra spaces or characters.
+> - ⚠️ **Warning**: Avoid sharing your API key publicly to keep it secure.
+> - 🔄 **If You Encounter Issues**: Double-check your internet connection and ensure your API key is valid.
+> - **This step is crucial to unlock the full functionality of the plugin, including advanced spatial analysis workflows.**
+---
 
 
 

diff --git a/docs/userguide/navigation.html b/docs/userguide/navigation.html
@@ -433,6 +433,12 @@ <h2> Contents </h2>
                 <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-the-plugin">Accessing the Plugin</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#navigating-the-plugin-window">Navigating the Plugin Window</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-up-the-ors-key">Setting Up the ORS Key</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-get-your-api-key"><strong>Step 1: Get Your API Key</strong></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-paste-the-api-key"><strong>Step 2: Paste the API Key</strong></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-verify-the-key"><strong>Step 3: Verify the Key</strong></a></li>
+</ul>
+</li>
 </ul>
             </nav>
         </div>
@@ -487,12 +493,52 @@ <h2>Navigating the Plugin Window<a class="headerlink" href="#navigating-the-plug
 <li><p><strong>About Page</strong>: This page offers detailed information about the plugin, including its contributors, development background, and licensing. It highlights the open-source nature of the tool and acknowledges the organizations or individuals involved in its creation.</p></li>
 </ul>
 </div></blockquote>
-<ul>
-<li><p align="justify"><strong>Welcome to GEEST Page</strong>: This is the introductory page of the plugin, providing an overview of its purpose and functionality. It serves as the starting point to familiarize users with the plugin's capabilities and its relevance to geospatial analysis.</p>
-</li>
-<li><p align="justify"><strong>About Page</strong>: This page offers detailed information about the plugin, including its contributors, development background, and licensing. It highlights the open-source nature of the tool and acknowledges the organizations or individuals involved in its creation.</p>
-</li>
+</section>
+<section id="setting-up-the-ors-key">
+<h2>Setting Up the ORS Key<a class="headerlink" href="#setting-up-the-ors-key" title="Permalink to this heading">#</a></h2>
+<p>To use the GEEST plugin effectively, you need to configure the <strong>Open Route Service (ORS)</strong> API key. The ORS platform is used for spatial analysis workflows, and obtaining an API key is a simple and free process. Below are the steps:</p>
+<hr class="docutils" />
+<section id="step-1-get-your-api-key">
+<h3><strong>Step 1: Get Your API Key</strong><a class="headerlink" href="#step-1-get-your-api-key" title="Permalink to this heading">#</a></h3>
+<ol class="arabic simple">
+<li><p>Open your browser and go to the <a class="reference external" href="https://openrouteservice.org/sign-up/">ORS API Key Signup Page</a>.</p></li>
+<li><p>Register for an account or log in if you already have one.</p></li>
+<li><p>Once logged in, generate an API key by following the on-screen instructions.</p></li>
+</ol>
+</section>
+<section id="step-2-paste-the-api-key">
+<h3><strong>Step 2: Paste the API Key</strong><a class="headerlink" href="#step-2-paste-the-api-key" title="Permalink to this heading">#</a></h3>
+<ol class="arabic simple">
+<li><p>Copy the API key from the ORS website.</p></li>
+<li><p>Open the <strong>GEEST ORS Setup</strong> window in the plugin.</p></li>
+<li><p>Paste the API key into the text box provided (as shown in the screenshot below).</p></li>
+</ol>
+<p align="center">
+ <img 
+    src="https://raw.githubusercontent.com/worldbank/GEEST/main/docs/images/new%20images/ORS%20setup.jpg" 
+    alt="ORS key" 
+    style="width:45%;" 
+    title="Click to enlarge" 
+    onclick="window.open(this.src, '_blank')">
+</p>
+</section>
+<section id="step-3-verify-the-key">
+<h3><strong>Step 3: Verify the Key</strong><a class="headerlink" href="#step-3-verify-the-key" title="Permalink to this heading">#</a></h3>
+<ol class="arabic simple">
+<li><p>After pasting the API key, click the <strong>Check my key…</strong> button.</p></li>
+<li><p>If the key is valid, a green checkmark will appear, indicating the API key has been successfully set up.</p></li>
+</ol>
+<hr class="docutils" />
+<blockquote>
+<div><h4 class="rubric" id="tips-for-setting-up-the-ors-key"><strong>Tips for Setting Up the ORS Key</strong></h4>
+<ul class="simple">
+<li><p>💡 <strong>Tip</strong>: Ensure you paste the exact API key without any extra spaces or characters.</p></li>
+<li><p>⚠️ <strong>Warning</strong>: Avoid sharing your API key publicly to keep it secure.</p></li>
+<li><p>🔄 <strong>If You Encounter Issues</strong>: Double-check your internet connection and ensure your API key is valid.</p></li>
+<li><p><strong>This step is crucial to unlock the full functionality of the plugin, including advanced spatial analysis workflows.</strong></p></li>
 </ul>
+</div></blockquote>
+<hr class="docutils" />
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="contextual.html">Contextual</a></li>
@@ -505,6 +551,7 @@ <h2>Navigating the Plugin Window<a class="headerlink" href="#navigating-the-plug
 </ul>
 </div>
 </section>
+</section>
 </section>
 
     <script type="text/x-thebe-config">
@@ -573,6 +620,12 @@ <h2>Navigating the Plugin Window<a class="headerlink" href="#navigating-the-plug
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#accessing-the-plugin">Accessing the Plugin</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#navigating-the-plugin-window">Navigating the Plugin Window</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-up-the-ors-key">Setting Up the ORS Key</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-1-get-your-api-key"><strong>Step 1: Get Your API Key</strong></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-2-paste-the-api-key"><strong>Step 2: Paste the API Key</strong></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#step-3-verify-the-key"><strong>Step 3: Verify the Key</strong></a></li>
+</ul>
+</li>
 </ul>
   </nav></div>