first pass at HUgo docs UI

README.md

@@ -24,17 +24,10 @@ Initial launch of the application displays a thorough "Introduction" to the WKT
 it or dismiss it; you can peruse it at any time using `Help > Show Introduction`.
 
 ## About the Documentation
-For detailed user information, read the following:
 
-- WebLogic Kubernetes Toolkit UI [Prerequisites](site/prerequisites.md)
-- About the [WKT UI Application](site/setup.md)
-- [Navigate the WKT UI](site/project-settings.md)
- - [Model](site/model.md)
- - [Image](site/image.md)
- - [Kubernetes](site/k8s-client-config.md)
- - [Verrazzano](site/verrazzano.md)
+Documentation for WebLogic Kubernetes Toolkit UI is available here.
 
-For developer information, see [WebLogic Kubernetes Toolkit UI Project](site/developer.md).
+This documentation includes information for users and for developers.
 
 ## Get Help
 

documentation/1.0/content/_index.md

@@ -1,10 +1,5 @@
----
-title: "WebLogic Kubernetes Toolkit UI Documentation"
-date: 2021-10-14T11:13:41-05:00
-draft: true
----
+## WebLogic Kubernetes Toolkit UI Documentation
 
-# WebLogic Kubernetes Toolkit UI Documentation
 The WebLogic Kubernetes Toolkit (WKT) is a collection of open source tools that help you provision WebLogic-based
 applications to run in Linux containers on a Kubernetes cluster. WKT includes the following tools:
 
@@ -20,38 +15,32 @@ The WKT UI provides a graphical user interface that wraps the WKT tools, Docker,
 a Linux container image to use to run the domain, and setting up and deploying the software and configuration
 necessary to deploy and access the domain in your Kubernetes cluster.
 
-## Get Started
+### Current release
 
-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.
-Simply run the appropriate installer for your operating system.
+WebLogic Kubernetes Toolkit UI version and release information can be found [here](https://github.com/oracle/weblogic-toolkit-ui/releases).
 
-
-Initial launch of the application displays a thorough "Introduction" to the WKT UI. Step through
-it or dismiss it; you can peruse it at any time using `Help > Show Introduction`.
-
-## About the Documentation
+### About the Documentation
 For detailed user information, read the following:
 
-- WebLogic Kubernetes Toolkit UI [Prerequisites](site/prerequisites.md)
-- About the [WKT UI Application](site/setup.md)
-- [Navigate the WKT UI](site/project-settings.md)
- - [Model](site/model.md)
- - [Image](site/image.md)
- - [Kubernetes](site/k8s-client-config.md)
- - [Verrazzano](site/verrazzano.md)
+- [About the WKT UI Application]({{< relref "/concepts/_index.md" >}})
+- WebLogic Kubernetes Toolkit UI [Prerequisites]({{< relref "/setup/prerequisites.md" >}}) and [Installation]({{< relref "/setup/install.md" >}})
+- [Navigate the WKT UI]({{< relref "/navigate/_index.md" >}})
+ - [Model]({{< relref "/navigate/model.md" >}})
+ - [Image]({{< relref "/navigate/image.md" >}})
+ - [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}})
+ - [Verrazzano]({{< relref "/navigate/verrazzano.md" >}})
 
-For developer information, see [WebLogic Kubernetes Toolkit UI Project](site/developer.md).
+For developer information, see [WebLogic Kubernetes Toolkit UI Project]({{< relref "/developer/_index.md" >}})
 
-## Get Help
+### Get Help
 
 We have a closely monitored public Slack channel where you can get in touch with us to ask questions about using the
 WebLogic Toolkit UI or give us feedback or suggestions about what features and improvements you would like to see.
 We would love to hear from you.
 
-## Related Projects
+### Related Projects
 For detailed documentation and access to WebLogic Toolkit-related projects, see:
 
 - [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
 - [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/)
 - [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
-

site/setup.md → documentation/1.0/content/concepts/_index.md

@@ -1,5 +1,14 @@
-## Contents
-- [About the WKT UI Application](#about-the-wkt-ui-application)
++++
+title = "About the WKT UI Application"
+date = 2019-02-22T15:27:38-05:00
+weight = 1
+pre = "<b> </b>"
++++
+
+
+
+### Contents
+
 - [WKT Project File](#wkt-project-file)
 - [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file)
  - [Environment Variables](#environment-variables)
@@ -9,9 +18,9 @@
  - [WebLogic Kubernetes Toolkit UI Introduction Configuration](#weblogic-kubernetes-toolkit-ui-introduction-configuration)
  - [External Applications](#external-applications)
  - [Bundled WKT Applications](#bundled-wkt-applications)
-- [Next Steps](#next-steps)
 
-## About the WKT UI Application
+
+
 Before giving you the whirlwind tour of the WKT UI application, it is important to know that the application is a native,
 desktop application. It uses native operating system features, such as:
 
@@ -25,7 +34,7 @@ desktop application. It uses native operating system features, such as:
  display the recently used `.wktproj` files and selecting one will open an application window and load the contents
  of the `.wktproj` file.
 
-## WKT Project File
+### WKT Project File
 What is a `.wktproj` file? Simply put, it is the application's equivalent of an Integrated Development Environment
 (IDE) project file. It stores:
 
@@ -45,7 +54,7 @@ The WKT UI application uses a one project per window paradigm and most everythin
 affected by the project data, either stored directly in the project file or in the WDT model-related files referenced
 by the project. However, there are a few exceptions that are covered in [Settings Outside the WKT Project File](#settings-outside-the-wkt-project-file).
 
-## Settings Outside the WKT Project File
+### Settings Outside the WKT Project File
 
 Multiple factors influence the behavior of the WKT UI application in a particular environment. Other than the WKT Project file,
 those include:
@@ -56,7 +65,7 @@ those include:
 - [External Applications](#external-applications) - The application or its components depend on an application being available and properly configured.
 - [Bundled WKT Applications](#bundled-wkt-applications) - The application bundles its own copies of WebLogic Deploy Tooling and WebLogic Image Tool.
 
-### Environment Variables
+#### Environment Variables
 Some of the application's behavior is influenced by environment variables it inherits when it is started. Environment
 variables affect the behavior of the WKT UI application when computing default values for application form fields. Some
 examples are:
@@ -65,12 +74,14 @@ examples are:
 - `JAVA_HOME` - Used as one way to find the directory where the Java Development Kit (JDK) is installed.
 - `ORACLE_HOME` and `MW_HOME` - Used to find the Oracle Fusion Middleware installation directory.
 
-**NOTE**: On Windows and Linux platforms, this tends to be the user's environment that they have configured to be used when
+{{% notice note %}}
+On Windows and Linux platforms, this tends to be the user's environment that they have configured to be used when
 they log in. On MacOS, native applications do not inherit the user's login environment. Instead, the application
 inherits the environment configured by the `launchd` daemon process. If you are running on MacOS, then you should keep this in mind
 when the application doesn't behave as you expect.
+{{% /notice %}}
 
-### User Preferences
+#### User Preferences
 
 The `Preferences` menu lets you configure settings that affect the behavior of the WKT UI application for the user
 across all instances of the application on the machine. These user-visible settings include the following categories:
@@ -83,7 +94,7 @@ Settings are also used to store internally used values that impact the appearanc
 Window size is stored so that the application will open the window with your last known window size. The list of
 such appearance-related settings will likely grow over time.
 
-#### Proxy Configuration
+##### Proxy Configuration
 
 If the WKT UI application is to be run from an environment where a proxy server is required to access the Internet, then you
 must configure the proxy server settings to allow Internet access. Currently, the UI depends on access to
@@ -102,7 +113,7 @@ following fields, as needed:
  For example, a value of `.us.mycompany.com,.emea.mycompany.com,.apac.mycompany.com` will skip the proxy for any
  DNS name that ends in one of the three domain names.
 
-#### Logging Configuration
+##### Logging Configuration
 
 Using this section, you can configure the logging output level and control the log file directory. The defaults are:
 
@@ -111,12 +122,12 @@ Using this section, you can configure the logging output level and control the l
 - `Log File Directory` - The directory to which log files are written. The default is the user's temporary directory, as
  defined by the operating system.
 
-#### WebLogic Kubernetes Toolkit UI Introduction Configuration
+##### WebLogic Kubernetes Toolkit UI Introduction Configuration
 
 This setting lets you turn on or off the in-application introductory information being displayed at startup. `Show Introduction` is always
 accessible from the `Help` menu.
 
-### External Applications
+#### External Applications
 
 The WKT UI application depends on several external applications for its functionality. As such, it is important to install and
 configure these external applications properly on the local machine on which the application is running.
@@ -130,7 +141,7 @@ configure these external applications properly on the local machine on which the
 - `openssl` - Used to generate X.509 TLS certificates, should you ask the application to
  generate one for your ingress route(s), only if you ask the application to generate it for you.
 
-### Bundled WKT Applications
+#### Bundled WKT Applications
 
 [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/) (WDT) and [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/) (WIT) are bundled with the WKT UI application. These tools are:
 
@@ -141,8 +152,3 @@ configure these external applications properly on the local machine on which the
 
 Use `Help` > `Check For Updates` periodically to make sure you are using the latest versions of these
 bundled tools.
-
-## Next Steps
-
-- Get started in the [WKT UI](site/project-settings.md).
-- Learn about [WKT Project](project-settings.md#project-settings) Settings.

site/developer.md → documentation/1.0/content/developer/_index.md

@@ -1,27 +1,37 @@
-# WebLogic Kubernetes Toolkit UI Project
++++
+title = "Developer Guide"
+date = 2019-02-22T15:27:38-05:00
+weight = 4
+pre = "<b> </b>"
++++
+
+
+
 
 The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment.
 
-## Setting up your development environment
+#### Setting up your development environment
+When working with this project, you must be on the Oracle network.
+
 1. Download and install the latest LTS version of node.js from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
-2. If you rely on a proxy server to reach the Internet, set these 5 environment variables to configure the proxy correctly:
+2. Create the file ~/.npmrc (%USERPROFILE%\.npmrc on Windows) with the following content:
+ ```
+ registry=https://artifacthub-tip.oraclecorp.com/api/npm/npmjs-remote
+ noproxy=localhost,127.0.0.1,.local,.oracle.com,.oraclecorp.com
+ ```
+3. Set these 5 environment variables to configure the proxy correctly:
  ```
  ELECTRON_GET_USE_PROXY=true
- GLOBAL_AGENT_HTTPS_PROXY=<proxy-url>
- WKTUI_DEV_PROXY=<proxy-url>
- HTTPS_PROXY=<proxy-url>
- NO_PROXY=<list-of-no-proxy-hosts>
+ GLOBAL_AGENT_HTTPS_PROXY=http://www-proxy-hqdc.us.oracle.com:80
+ WKTUI_DEV_PROXY=http://www-proxy-hqdc.us.oracle.com:80
+ HTTPS_PROXY=http://www-proxy-hqdc.us.oracle.com:80
+ NO_PROXY=.oraclecorp.com,.us.oracle.com,.oraclevcn.com
  ```
-3. Open a command line window are run the following command to update the version of npm to the latest:
+4. Open a command line window are run the following command to update the version of npm to the latest:
  ```bash
  sudo npm install --global npm
  ```
- Note: If developing on Windows, run the following commands from a shell running as Administrator instead: 
- ```cmd
- npm install --global --production npm-windows-upgrade
- npm-windows-upgrade --npm-version latest
- ```
-4. Set up your global git configuration by running the following commands:
+5. Set up your global git configuration by running the following commands:
  ```bash
  git config --global user.name "<your real name>"
  git config --global user.email "<your-oracle-email-address>"
@@ -30,18 +40,19 @@ The WebLogic Kubernetes Toolkit UI is a desktop application designed to help Web
  **This last command is critical if you are developing on either Windows or MacOS. Yes, the MacOS file system
  is, by default, case-insensitive!**
 
-5. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
-6. Open a command-line in the `wktui` directory and run `npm install` to download and install the JavaScript dependencies required by the project.
-7. Open a command-line in the `wktui/electron` directory and run `npm run install-tools`.
-8. Open a command-line in the `wktui/webui` directory and run `npm start`.
-9. Once the server from the previous step is fully running, open a command-line in the `wktui/electron` directory and run `npm start`.
 
-## Building a Windows or MacOS installer
+6. Clone the git repository on GitHub at [https://github.com/oracle/weblogic-toolkit-ui](https://github.com/oracle/weblogic-toolkit-ui).
+7. Open a command-line in the `wktui` directory and run `npm install` to download and install the JavaScript dependencies required by the project.
+8. Open a command-line in the `wktui/electron` directory and run `npm run install-tools`.
+9. Open a command-line in the `wktui/webui` directory and run `npm start`.
+10. Once the server from the previous step is fully running, open a command-line in the `wktui/electron` directory and run `npm start`.
+
+#### Building a Windows or MacOS installer
 0. Set up your development environment and verify that the application is working properly from it.
 1. Open a command-line in the `wktui/electron` directory and run `npm run build`.
 2. Find the executable and installer(s) in the `wktui/dist` directory.
 
-## Building a Linux installer
+#### Building a Linux installer
 0. Set up your development environment and verify that the application is working properly from it.
 1. Open a command-line in the `wktui/webui` directory and run `npm run build:release`.
 2. From the command-line in the `wktui/scripts` directory, run `./devBuildLinuxInstallers.sh`.

documentation/1.0/content/navigate/_index.md

@@ -0,0 +1,34 @@
++++
+title = "Navigate the UI"
+date = 2019-02-22T15:27:38-05:00
+weight = 3
+pre = "<b> </b>"
++++
+
+#### Before you begin
+
+Make sure you have read [About the WKT UI Application]({{< relref "/concepts/_index.md" >}}).
+
+#### About the UI
+
+To help you understand how to use the WKT UI, we will step you through it, section by section,
+describing the important decisions to make and fields to populate. The sections are listed in
+the left side navigation pane. Depending on the `Kubernetes Environment Target Type` field
+on the `Project Settings` page, you will see either the `Kubernetes` or `Verrazzano` section. 
+
+The UI sections are:
+
+- [Project Settings]({{< relref "/navigate/project-settings.md" >}})
+- [Model]({{< relref "/navigate/model.md" >}})
+- [Image]({{< relref "/navigate/image.md" >}})
+- [Kubernetes]({{< relref "/navigate/kubernetes/_index.md" >}})
+ - [Client Configuration]({{< relref "/navigate/kubernetes/k8s-client-config.md" >}})
+ - [WebLogic Operator]({{< relref "/navigate/kubernetes/k8s-wko.md" >}})
+ - [WebLogic Domain]({{< relref "/navigate/kubernetes/k8s-weblogic-domain.md" >}})
+ - [Ingress Controller]({{< relref "/navigate/kubernetes/k8s-ingress-controller.md" >}})
+- [Verrazzano]({{< relref "/navigate/verrazzano.md" >}})
+ - Client Configuration
+ - Application
+
+At the bottom of the page, the collapsed `Console` panel automatically appears and displays the `stdout` and `stderr`
+streams when running certain actions, such as `Prepare Model`.