Skip to content

Commit cbd5dd4

Browse files
fix nits
1 parent d847085 commit cbd5dd4

File tree

8 files changed

+46
-46
lines changed

8 files changed

+46
-46
lines changed

documentation/1.0/content/developer/_index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ pre = "<b> </b>"
88
The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment.
99

1010
### Setting up your development environment
11-
1. Download and install the latest LTS version of node.js from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
12-
2. If you rely on a proxy server to reach the Internet, set these 5 environment variables to configure the proxy correctly:
11+
1. Download and install the latest LTS version of `node.js` from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
12+
1. If you rely on a proxy server to reach the Internet, set these five environment variables to configure the proxy correctly:
1313
```
1414
ELECTRON_GET_USE_PROXY=true
1515
GLOBAL_AGENT_HTTPS_PROXY=<proxy-url>
1616
WKTUI_DEV_PROXY=<proxy-url>
1717
HTTPS_PROXY=<proxy-url>
1818
NO_PROXY=<list-of-no-proxy-hosts>
1919
```
20-
3. Open a command line window are run the following command to update the version of npm to the latest:
20+
1. Open a command line and run the following command to update the version of `npm` to the latest:
2121
```bash
2222
sudo npm install --global npm
2323
```
24-
Note: If developing on Windows, run the following commands from a shell running as Administrator instead:
24+
**Note**: If developing on Windows, run the following commands from a shell running as Administrator instead:
2525
```cmd
2626
npm install --global --production npm-windows-upgrade
2727
npm-windows-upgrade --npm-version latest
2828
```
29-
4. Set up your global git configuration by running the following commands:
29+
1. Set up your global git configuration by running the following commands:
3030
```bash
3131
git config --global user.name "<your real name>"
3232
git config --global user.email "<your-oracle-email-address>"
@@ -35,19 +35,19 @@ The WebLogic Kubernetes Toolkit UI is a desktop application designed to help Web
3535
**This last command is critical if you are developing on either Windows or MacOS. Yes, the MacOS file system
3636
is, by default, case-insensitive!**
3737

38-
5. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
39-
6. Open a command-line in the `weblogic-toolkit-ui` directory and run `npm install` to download and install the JavaScript dependencies required by the project.
40-
7. Open a command-line in the `weblogic-toolkit-ui/electron` directory and run `npm run install-tools`.
41-
8. Open a command-line in the `weblogic-toolkit-ui/webui` directory and run `npm start`.
42-
9. Once the server from the previous step is fully running, open a command-line in the `weblogic-toolkit-ui/electron` directory and run `npm start`.
38+
1. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
39+
1. Open a command line in the `weblogic-toolkit-ui` directory and run `npm install` to download and install the JavaScript dependencies required by the project.
40+
1. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run install-tools`.
41+
1. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm start`.
42+
1. After the server from the previous step is fully running, open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm start`.
4343

4444
### Building a Windows or MacOS installer
45-
0. Set up your development environment and verify that the application is working properly from it.
46-
1. Open a command-line in the `weblogic-toolkit-ui/electron` directory and run `npm run build`.
47-
2. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.
45+
1. Set up your development environment and verify that the application is working properly from it.
46+
1. Open a command line in the `weblogic-toolkit-ui/electron` directory and run `npm run build`.
47+
1. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.
4848

4949
### Building a Linux installer
50-
0. Set up your development environment and verify that the application is working properly from it.
51-
1. Open a command-line in the `weblogic-toolkit-ui/webui` directory and run `npm run build:release`.
52-
2. From the command-line in the `weblogic-toolkit-ui/scripts` directory, run `./devBuildLinuxInstallers.sh`.
53-
3. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.
50+
1. Set up your development environment and verify that the application is working properly from it.
51+
1. Open a command line in the `weblogic-toolkit-ui/webui` directory and run `npm run build:release`.
52+
1. From the command line in the `weblogic-toolkit-ui/scripts` directory, run `./devBuildLinuxInstallers.sh`.
53+
1. Find the executable and installer(s) in the `weblogic-toolkit-ui/dist` directory.

documentation/1.0/content/navigate/image.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -185,10 +185,10 @@ the `Create Image` button on the `Image` page or the `Go` menu.
185185
At a high level, `Create Image` performs the following steps:
186186

187187
1. Validates the input values necessary for running the action based on your selections.
188-
2. Saves the WKT Project, if needed.
189-
3. Adds the installers to the WIT cache on the local machine using the WebLogic Image Tool
188+
1. Saves the WKT Project, if needed.
189+
1. Adds the installers to the WIT cache on the local machine using the WebLogic Image Tool
190190
[Cache](https://oracle.github.io/weblogic-image-tool/userguide/tools/cache/) command.
191-
4. Builds the image on the local machine using the WebLogic Image Tool
191+
1. Builds the image on the local machine using the WebLogic Image Tool
192192
[Create](https://oracle.github.io/weblogic-image-tool/userguide/tools/create-image/) command.
193193

194194
### Push Image
@@ -200,6 +200,6 @@ At a high level, `Push Image` performs the following steps:
200200

201201
1. Validates the input values necessary for running the action based on your selections. This includes making
202202
sure that an image with the specified `Image Tag` value exists in the local machine's image cache.
203-
2. Saves the WKT Project, if needed.
204-
3. Logs in to the container image registry, if specified.
205-
4. Pushes the image to the container image registry.
203+
1. Saves the WKT Project, if needed.
204+
1. Logs in to the container image registry, if specified.
205+
1. Pushes the image to the container image registry.

documentation/1.0/content/navigate/kubernetes/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Kubernetes cluster where the WebLogic domain will be managed by the WebLogic Kub
1010
to help you:
1111

1212
1. [Configure]({{< relref "/navigate/kubernetes/k8s-client-config#client-configuration" >}}) your Kubernetes client (`kubectl`) to connect to the Kubernetes cluster.
13-
2. [Install]({{< relref "/navigate/kubernetes/k8s-wko#install-operator" >}}) the WebLogic Kubernetes Operator.
14-
3. [Deploy]({{< relref "/navigate/kubernetes/k8s-weblogic-domain#deploy-domain" >}}) the WebLogic domain's `Domain` resource configuration used by WebLogic Kubernetes Operator.
15-
4. [Install]({{< relref "/navigate/kubernetes/k8s-ingress-controller#install-ingress-controller" >}}) an ingress controller, if needed, and add ingress routes to allow access to the WebLogic domain from
13+
1. [Install]({{< relref "/navigate/kubernetes/k8s-wko#install-operator" >}}) the WebLogic Kubernetes Operator.
14+
1. [Deploy]({{< relref "/navigate/kubernetes/k8s-weblogic-domain#deploy-domain" >}}) the WebLogic domain's `Domain` resource configuration used by WebLogic Kubernetes Operator.
15+
1. [Install]({{< relref "/navigate/kubernetes/k8s-ingress-controller#install-ingress-controller" >}}) an ingress controller, if needed, and add ingress routes to allow access to the WebLogic domain from
1616
outside the Kubernetes cluster.
1717

1818
{{% children style="h4" description="true" %}}

documentation/1.0/content/navigate/kubernetes/k8s-ingress-controller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This section supports two distinct functions related to an ingress controller.
2121
controller to a Kubernetes cluster. Second, it supports adding the necessary routes to an ingress controller to make
2222
a deployed WebLogic domain's endpoints accessible.
2323

24-
#### Design View
24+
### Design View
2525
`Design View` helps you specify the data needed to install an ingress controller, if desired, and
2626
specify the data needed to expose one or more endpoints for a deployed WebLogic domain. This page contains three panes:
2727

documentation/1.0/content/navigate/kubernetes/k8s-wko.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,9 @@ to the image registry specified by its image tag. You can access it by using th
171171
At a high level, `Push Image` performs the following steps:
172172

173173
1. Validates the input values necessary for running the action based on your selections.
174-
2. Saves the WKT Project, if needed.
175-
3. Creates the Kubernetes namespace for installing the operator, if needed.
176-
4. Creates the Kubernetes service account for the operator to use, if needed.
177-
5. Creates the operator image pull secret, if needed.
178-
6. Adds the latest operator Helm chart to the local Helm repository.
179-
7. Runs Helm to install the operator using the specified configuration.
174+
1. Saves the WKT Project, if needed.
175+
1. Creates the Kubernetes namespace for installing the operator, if needed.
176+
1. Creates the Kubernetes service account for the operator to use, if needed.
177+
1. Creates the operator image pull secret, if needed.
178+
1. Adds the latest operator Helm chart to the local Helm repository.
179+
1. Runs Helm to install the operator using the specified configuration.

documentation/1.0/content/navigate/model.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ title bar and follow the prompts to choose the type of content to add and select
108108
For example, to add a WAR file called `todo.war` to the archive, do the following:
109109

110110
1. On the archive editor title bar, click `+`.
111-
2. In the resulting dialog, choose `Application File` from the list and click `OK`.
112-
3. In the resulting file chooser dialog, select the `todo.war` file and click `Select`.
111+
1. In the resulting dialog, choose `Application File` from the list and click `OK`.
112+
1. In the resulting file chooser dialog, select the `todo.war` file and click `Select`.
113113

114114
This will result in the file structure `wlsdeploy/applications/todo.war` being added to the archive editor pane.
115115
At this point, the application has not created or modified the archive file; it is simply storing
@@ -144,10 +144,10 @@ Image` action, though typically it is best to run `Prepare Model` explicitly, pr
144144
`Prepare Model` does the following:
145145

146146
1. Removes model sections and fields that are not compatible with the target environment.
147-
2. Replaces endpoint values with model tokens that reference variables.
148-
3. Replaces credential values with model tokens that reference either a field in a Kubernetes secret or a variable.
149-
4. Provides default values for fields displayed in the application's variable, variable overrides, and secret editors.
150-
5. Extracts topology information to the application that it uses to generate the resource file used to deploy the domain.
147+
1. Replaces endpoint values with model tokens that reference variables.
148+
1. Replaces credential values with model tokens that reference either a field in a Kubernetes secret or a variable.
149+
1. Provides default values for fields displayed in the application's variable, variable overrides, and secret editors.
150+
1. Extracts topology information to the application that it uses to generate the resource file used to deploy the domain.
151151

152152
For more information, see the WDT [model tokens](https://oracle.github.io/weblogic-deploy-tooling/concepts/model/#model-tokens)
153153
documentation.

documentation/1.0/content/navigate/project-settings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ A creative person might realize that they can use the passphrase-based encryptio
4646
in the native OS credential store to another machine. The steps to accomplish this would be:
4747

4848
1. Open the project using the native OS credential store on the machine where the credentials are stored.
49-
2. Change the credential storage option to passphrase-based encryption and enter a passphrase.
50-
3. Save the project file.
51-
4. Open the project file on a different machine, supplying the passphrase entered in step 2.
52-
5. Change the credential storage option to native OS credential store.
53-
6. Save the project file.
49+
1. Change the credential storage option to passphrase-based encryption and enter a passphrase.
50+
1. Save the project file.
51+
1. Open the project file on a different machine, supplying the passphrase entered in step 2.
52+
1. Change the credential storage option to native OS credential store.
53+
1. Save the project file.
5454

5555
The final choice, `Not Stored`, is to not store the credentials at all. While this is a viable option, it also means that whenever you
5656
need to run any of the actions that require credentials, you will need to re-enter the value of every credential in the

documentation/1.0/content/setup/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 2
66
description: "Install the WKT UI application and check for updates."
77
---
88

9-
1. Download the latest WebLogic Kubernetes Toolkit UI (WKT UI) application installers from the [Github Releases section](https://github.com/oracle/weblogic-toolkit-ui/releases) of this repository.
9+
1. Download the latest WebLogic Kubernetes Toolkit UI (WKT UI) application installers from the [GitHub Releases section](https://github.com/oracle/weblogic-toolkit-ui/releases) of this repository.
1010
1. Simply run the appropriate installer for your operating system.
1111

1212
Application startup detects Internet connectivity to GitHub. If it fails to connect, a `Network Configuration` dialog appears in which you can set or modify your proxy settings, test your changes, and then restart the application.
@@ -19,8 +19,8 @@ Upon application startup, if a more recent version exists, an Application Update
1919

2020
- `Install Now`
2121
- `Install on Exit`
22-
- Not available on MacOS.
2322
- Downloads the application and installs it after you exit.
23+
- Not available on MacOS.
2424
- `Ignore Update`
2525

2626
At any time, you can check for application updates using `Help > Check for WKT UI Updates`.

0 commit comments

Comments
 (0)