Doc updates (support and fixes) (#839)

* Doc updates (support and fixes)
oracle · Feb 23, 2024 · 066d572 · 066d572
1 parent 1f7a8cc
commit 066d572
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 19 deletions.
diff --git a/docs-source/spring/content/azure/_index.md b/docs-source/spring/content/azure/_index.md
@@ -22,7 +22,7 @@ Watch this video for a quick overview of the setup process.
 
 ## Download
 
-Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
+Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.1/azure-ebaas_latest.zip).
 
 ## Setup
 
@@ -55,7 +55,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following s
 
    ![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
 
-3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas-platform_latest.zip) stack. For example:
+3. Upload the [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.1/azure-ebaas-platform_latest.zip) stack. For example:
 
    ![Azure Upload](AzureUpload.png)
 

diff --git a/docs-source/spring/content/development/cli/_index.md b/docs-source/spring/content/development/cli/_index.md
@@ -9,6 +9,7 @@ microservices applications as well as bindings with the resources that they use.
 
 Table of Contents:
 
+* [Installing the CLI](#installing-the-cli)
 * [Using the CLI](#using-the-cli)
 * [Available Commands](#available-commands)
   * [Help](#help)
@@ -25,6 +26,28 @@ Table of Contents:
   * [User Management](#user-management)  
 * [Logging Information](#logging)
 
+## Installing the CLI
+
+The Oracle Backend for Spring Boot CLI is used to configure your backend and to deploy your Spring Boot applications to the backend.
+
+1. Download the Oracle Backend for Spring Boot and Microservices CLI `oractl`
+
+   Download the CLI from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.1)
+
+1. Rename the downloaded file to `oractl`
+
+1. Add `oractl` to PATH variable
+
+   You need to make sure it is executable and add it to your PATH environment variable.
+
+    ```shell
+    <copy>
+    chmod +x oractl
+    export PATH=/path/to/oractl:$PATH</copy>
+    ```
+
+**NOTE:** If environment is a Mac you need run the following command `sudo xattr -r -d com.apple.quarantine <downloaded-file>` otherwise will you get a security warning and the CLI will not work.
+
 ## Using the CLI
 
 1. Expose the Oracle Backend for Spring Boot and Microservices Admin server that the CLI calls using this command:
@@ -41,22 +64,20 @@ Table of Contents:
 
     As a result, the `oractl` prompt is displayed as follows:
 
-    ```bash
-     _   _           __    _    ___
-    / \ |_)  _.  _. (_    /  |   |
-    \_/ |_) (_| (_| __)   \_ |_ _|_
-    ========================================================================================
+    ```text
+       _   _           __    _    ___
+      / \ |_)  _.  _. (_    /  |   |
+      \_/ |_) (_| (_| __)   \_ |_ _|_
+      ========================================================================================
+      Application Name: Oracle Backend Platform :: Command Line Interface
+      Application Version: (1.1.1)
+      :: Spring Boot (v3.2.1) ::
 
-    Application Name: Oracle Backend Platform :: Command Line Interface
-    Application Version: (1.1.0)
-    :: Spring Boot (v3.2.1) ::
+      Ask for help:
+      - Slack: https://oracledevs.slack.com/archives/C03ALDSV272
+      - email: obaas_ww@oracle.com
 
-    Ask for help:
-
-    * Slack: <https://oracledevs.slack.com/archives/C03ALDSV272>
-    * email: <obaas_ww@oracle.com>
-
-    oractl:>
+      oractl:>
     ```
 
 ## Available Commands

diff --git a/docs-source/spring/content/platform/vscode-plugin/_index.md b/docs-source/spring/content/platform/vscode-plugin/_index.md
@@ -20,7 +20,7 @@ You must have already installed and configured the following software which requ
 
 ## Installation
 
-1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.0).
+1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.1).
 
 2. On the VS Code left menu bar, click on the **Extensions** symbol:
 

diff --git a/docs-source/spring/content/setup/_index.md b/docs-source/spring/content/setup/_index.md
@@ -106,7 +106,8 @@ You must meet the following prerequisites to use Oracle Backend for Spring Boot
 
   - The Kubernetes command-line interface (kubectl). [Installing kubectl documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
   - Oracle Cloud Infrastructure command-line interface (CLI). [Quickstart - Installing the CLI](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#Quickstart).
-  - Oracle Backend for Spring Boot and Microservices command-line interface (oractl). [Download oractl](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.0.0).
+  - Oracle Backend for Spring Boot and Microservices command-line interface (oractl). [Download oractl](https://github.com/oracle/microservices-datadriven/releases).
+  - [OPTIONAL]Oracle Backend for Spring Boot and Microservices VS Code Extension. [Download VS Code Extension](https://github.com/oracle/microservices-datadriven/releases).
 
 ## Summary of Components
 

diff --git a/docs-source/spring/content/support/_index.md b/docs-source/spring/content/support/_index.md
@@ -0,0 +1,16 @@
+---
+title: "Support"
+description: "Get help for Oracle Backend for Spring Boot and Microservices"
+keywords: "support backend oracle springboot spring development microservices database"
+---
+If you need help with Oracle Backend for Spring Boot and Microservices you can seek help at the following channels:
+
+- E-mail: obaas_ww@oracle.com
+- Slack: https://oracledevs.slack.com/archives/C06L9CDGR6Z
+- GitHub Issue: https://github.com/oracle/microservices-datadriven/issues
+
+When asking for help please provide the following:
+
+- Which version of Oracle Backend for Spring Boot and Microservices are you using?
+- Which component(s) do you have an issue with?
+- If possible, provide a testcase that shows the issue.
diff --git a/docs-source/spring/data/menu/main.yaml b/docs-source/spring/data/menu/main.yaml
@@ -81,5 +81,7 @@ main:
     ref: "/upgrade"
   - name: Uninstall
     ref: "/uninstall"
+  - name: Support
+    ref: "/support"
   - name: "Release Notes"
     ref: "/release-notes"
diff --git a/docs-source/spring/themes/hugo-geekdoc/i18n/en.yaml b/docs-source/spring/themes/hugo-geekdoc/i18n/en.yaml
@@ -36,7 +36,7 @@ posts_tagged_with: All posts tagged with '{{ . }}'
 
 footer_build_with: >
   Built with <svg class="gdoc-icon gdoc_heart"><use xlink:href="#gdoc_heart"></use></svg> by Oracle
-footer_legal_notice: (C) 2022, 2023, Oracle and/or its affiliates
+footer_legal_notice: (C) 2022, 2024, Oracle and/or its affiliates
 footer_privacy_policy: Privacy Policy
 footer_content_license_prefix: >
   Content licensed under Universal Permissive License