Skip to content

Commit 066d572

Browse files
authored
Doc updates (support and fixes) (#839)
* Doc updates (support and fixes)
1 parent 1f7a8cc commit 066d572

File tree

7 files changed

+59
-19
lines changed

7 files changed

+59
-19
lines changed

docs-source/spring/content/azure/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Watch this video for a quick overview of the setup process.
2222

2323
## Download
2424

25-
Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.0.0/azure-ebaas_latest.zip).
25+
Download [Oracle Backend for Spring Boot and Microservices](https://github.com/oracle/microservices-datadriven/releases/download/OBAAS-1.1.1/azure-ebaas_latest.zip).
2626

2727
## Setup
2828

@@ -55,7 +55,7 @@ The Multicloud installation is done using the Azure Cloud Shell. The following s
5555

5656
![Azure Cloud Shell Icon](AzureCloudShellIcon.png)
5757

58-
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:
58+
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:
5959

6060
![Azure Upload](AzureUpload.png)
6161

docs-source/spring/content/development/cli/_index.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ microservices applications as well as bindings with the resources that they use.
99

1010
Table of Contents:
1111

12+
* [Installing the CLI](#installing-the-cli)
1213
* [Using the CLI](#using-the-cli)
1314
* [Available Commands](#available-commands)
1415
* [Help](#help)
@@ -25,6 +26,28 @@ Table of Contents:
2526
* [User Management](#user-management)
2627
* [Logging Information](#logging)
2728

29+
## Installing the CLI
30+
31+
The Oracle Backend for Spring Boot CLI is used to configure your backend and to deploy your Spring Boot applications to the backend.
32+
33+
1. Download the Oracle Backend for Spring Boot and Microservices CLI `oractl`
34+
35+
Download the CLI from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.1)
36+
37+
1. Rename the downloaded file to `oractl`
38+
39+
1. Add `oractl` to PATH variable
40+
41+
You need to make sure it is executable and add it to your PATH environment variable.
42+
43+
```shell
44+
<copy>
45+
chmod +x oractl
46+
export PATH=/path/to/oractl:$PATH</copy>
47+
```
48+
49+
**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.
50+
2851
## Using the CLI
2952

3053
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:
4164

4265
As a result, the `oractl` prompt is displayed as follows:
4366

44-
```bash
45-
_ _ __ _ ___
46-
/ \ |_) _. _. (_ / | |
47-
\_/ |_) (_| (_| __) \_ |_ _|_
48-
========================================================================================
67+
```text
68+
_ _ __ _ ___
69+
/ \ |_) _. _. (_ / | |
70+
\_/ |_) (_| (_| __) \_ |_ _|_
71+
========================================================================================
72+
Application Name: Oracle Backend Platform :: Command Line Interface
73+
Application Version: (1.1.1)
74+
:: Spring Boot (v3.2.1) ::
4975
50-
Application Name: Oracle Backend Platform :: Command Line Interface
51-
Application Version: (1.1.0)
52-
:: Spring Boot (v3.2.1) ::
76+
Ask for help:
77+
- Slack: https://oracledevs.slack.com/archives/C03ALDSV272
78+
- email: obaas_ww@oracle.com
5379
54-
Ask for help:
55-
56-
* Slack: <https://oracledevs.slack.com/archives/C03ALDSV272>
57-
* email: <obaas_ww@oracle.com>
58-
59-
oractl:>
80+
oractl:>
6081
```
6182
6283
## Available Commands

docs-source/spring/content/platform/vscode-plugin/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You must have already installed and configured the following software which requ
2020

2121
## Installation
2222

23-
1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.0).
23+
1. Download the plug-in from [here](https://github.com/oracle/microservices-datadriven/releases/tag/OBAAS-1.1.1).
2424

2525
2. On the VS Code left menu bar, click on the **Extensions** symbol:
2626

docs-source/spring/content/setup/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ You must meet the following prerequisites to use Oracle Backend for Spring Boot
106106

107107
- The Kubernetes command-line interface (kubectl). [Installing kubectl documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
108108
- Oracle Cloud Infrastructure command-line interface (CLI). [Quickstart - Installing the CLI](https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#Quickstart).
109-
- 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).
109+
- Oracle Backend for Spring Boot and Microservices command-line interface (oractl). [Download oractl](https://github.com/oracle/microservices-datadriven/releases).
110+
- [OPTIONAL]Oracle Backend for Spring Boot and Microservices VS Code Extension. [Download VS Code Extension](https://github.com/oracle/microservices-datadriven/releases).
110111

111112
## Summary of Components
112113

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Support"
3+
description: "Get help for Oracle Backend for Spring Boot and Microservices"
4+
keywords: "support backend oracle springboot spring development microservices database"
5+
---
6+
If you need help with Oracle Backend for Spring Boot and Microservices you can seek help at the following channels:
7+
8+
- E-mail: obaas_ww@oracle.com
9+
- Slack: https://oracledevs.slack.com/archives/C06L9CDGR6Z
10+
- GitHub Issue: https://github.com/oracle/microservices-datadriven/issues
11+
12+
When asking for help please provide the following:
13+
14+
- Which version of Oracle Backend for Spring Boot and Microservices are you using?
15+
- Which component(s) do you have an issue with?
16+
- If possible, provide a testcase that shows the issue.

docs-source/spring/data/menu/main.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,7 @@ main:
8181
ref: "/upgrade"
8282
- name: Uninstall
8383
ref: "/uninstall"
84+
- name: Support
85+
ref: "/support"
8486
- name: "Release Notes"
8587
ref: "/release-notes"

docs-source/spring/themes/hugo-geekdoc/i18n/en.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ posts_tagged_with: All posts tagged with '{{ . }}'
3636

3737
footer_build_with: >
3838
Built with <svg class="gdoc-icon gdoc_heart"><use xlink:href="#gdoc_heart"></use></svg> by Oracle
39-
footer_legal_notice: (C) 2022, 2023, Oracle and/or its affiliates
39+
footer_legal_notice: (C) 2022, 2024, Oracle and/or its affiliates
4040
footer_privacy_policy: Privacy Policy
4141
footer_content_license_prefix: >
4242
Content licensed under Universal Permissive License

0 commit comments

Comments
 (0)