diff --git a/.github/workflows/publish-github-pages.yml b/.github/workflows/publish-github-pages.yml deleted file mode 100644 index 41855dff6..000000000 --- a/.github/workflows/publish-github-pages.yml +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright (c) 2021, Oracle and/or its affiliates. -# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. -# -# Description -# Use Hugo to build static site and publish to gh-pages -# -name: "PublishGitHubPages" - -on: - push: - branches: [ main ] - schedule: - - cron: '15 3 * * 1' - -defaults: - run: - shell: bash - -jobs: - publish: - name: Publish - runs-on: ubuntu-latest - - steps: - - name: Checkout main - uses: actions/checkout@v2.3.4 - with: - ref: main - fetch-depth: 32 - path: main - - - name: Checkout gh-pages - uses: actions/checkout@v2.3.4 - with: - ref: gh-pages - path: gh-pages - token: ${{ secrets.PUBLISH_SECRET }} - - - name: Verify changes to documentation present - id: change-check - run: | - cd $GITHUB_WORKSPACE/main - X=`git diff HEAD~1 --name-only | { grep "^documentation" || test $? = 1; } | wc -l` - if [ $X == "0" ]; then - echo 'No changes to the documenation' - else - echo '::set-output name=DOCUMENTATION_CHANGED::true' - fi - - name: Build and publish site - if: ${{ steps.change-check.outputs.DOCUMENTATION_CHANGED == 'true' }} - run: | - curl -fL -o hugo.tar.gz "https://github.com/gohugoio/hugo/releases/download/v0.88.1/hugo_0.88.1_Linux-64bit.tar.gz" - tar -zxf hugo.tar.gz - export PATH="$PWD:$PATH" - mkdir $GITHUB_WORKSPACE/WORK - cd $GITHUB_WORKSPACE/main/documentation - ./publish.sh -o $GITHUB_WORKSPACE/WORK - cd $GITHUB_WORKSPACE/gh-pages - rm -Rf * - cp -R $GITHUB_WORKSPACE/WORK/* . - git config --global user.name "github-actions[bot]" - git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" - git add --all - git commit -m "Documentation update from publish GitHub Action" - git push origin gh-pages diff --git a/.gitignore b/.gitignore deleted file mode 100644 index ed4e4e6cf..000000000 --- a/.gitignore +++ /dev/null @@ -1,104 +0,0 @@ -*~ -*# -.#* - -# Dependency directories -**/node_modules/ -**/bower_components/ - -# Optional npm cache directory -.npm - -# IntelliJ project files -**/*.iml -.idea - -# Visual Studio Code project files -.vscode/* -#!.vscode/settings.json -#!.vscode/tasks.json -#!.vscode/launch.json -#!.vscode/extensions.json -*.code-workspace - -# Local History for Visual Studio Code -.history/ - -# IDEs and editors -.project -.classpath -.c9/ -*.launch -.settings/ -*.sublime-workspace - -# compiled output -/dist -/tmp -/out-tsc -/tools/imagetool -/tools/weblogic-deploy -/out -/docker.env - -# Runtime data -pids -*.pid -*.seed -*.pid.lock - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# node-waf configuration -.lock-wscript - -# sonar scanner -.scannerwork -sonar-project.properties - -# misc -.sass-cache -connect.lock -typings - -# Logs -**/logs -**/*.log -**/npm-debug.log* -**/yarn-debug.log* -**/yarn-error.log* - -# Optional eslint cache -.eslintcache - -# Optional REPL history -.node_repl_history - -# Output of 'npm pack' -**/*.tgz - -# Yarn Integrity file -.yarn-integrity - -# dotenv environment variables file -.env - -# next.js build output -.next - -# Lerna -lerna-debug.log - -# System Files -.DS_Store -Thumbs.db diff --git a/404.html b/404.html new file mode 100644 index 000000000..e932ede64 --- /dev/null +++ b/404.html @@ -0,0 +1,57 @@ + + + +
+ + + + +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:
+.wktproj
extension and associates itself
+with that extension. For example, this lets you double-click on the file in the native file browser and
+have the application start and open the selected project..wktproj
files, the application adds those files to the OS-maintained
+list of recently used files. This causes these files to show up in OS-specific locations to provide shortcuts for
+opening the file with the application. For example, on macOS, right-clicking on the application icon in the dock will
+display the recently used .wktproj
files and selecting one will open an application window and load the contents
+of the .wktproj
file.What is a .wktproj
file? Simply put, it is the application’s equivalent of an Integrated Development Environment
+(IDE) project file. It stores:
There are two ways to create a new project:
+File
> New Project
and select the file location and name.Note that the file extension for project files must be .wktproj
. Otherwise, the application will not recognize the
+file as a project and will not allow it to be opened as a project file.
The WKT UI application uses a one project per window paradigm and most everything you do in the window is +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.
+Multiple factors influence the behavior of the WKT UI application in a particular environment. Other than the WKT Project file, +those include:
+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:
+PATH
- Used to locate executables like docker
, helm
, and kubectl
.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.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. For more information, see Project Settings.
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:
Settings are also used to store internally used values that impact the appearance of the application. For example, the +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.
+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
+github.com
to access release information and download new releases of the WKT tools and the UI itself. This connectivity
+is used in various places to determine default values for input data (for example, the default image tag to use for installing the
+WebLogic Kubernetes Operator) and providing updated features for the WKT tools bundled with the application, as
+well as updating the WKT UI application itself when a new release becomes available. Depending on the project configuration,
+the application may also require access to other sites, such as Docker Hub and other container registries, Helm chart
+download sites, and cloud-provider sites for authenticating to and accessing remote Kubernetes clusters.
To configure the proxy environment, use the Preferences
menu to add or update the
+following fields, as needed:
HTTPS Proxy URL
- The full URL to the proxy server (for example, http://my-proxy-server.mycompany.com:80).Bypass Proxy Hosts
- The comma-separated list of DNS or IP patterns that should not go through the proxy.
+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.Using this section, you can configure the logging output level and control the log file directory. The defaults are:
+File Transport Log Level
- The logging level below which log messages will be discarded. For example, Debug
messages
+will be discarded if the level is set to Info
. The default value is Info
.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.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.
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.
+docker
(or podman
) - Used to create new images and inspect the contents of
+custom base images. The WebLogic Image Tool depends on docker
(or podman
) for this functionality. docker
+(or podman
) is also used to log in to and interact with image registries.kubectl
- Used to get, create, and update configuration objects in your Kubernetes cluster.
+It is critical that the kubectl
configuration file is properly set up to allow kubectl
to authenticate to the cluster.helm
- Used to install the WebLogic Kubernetes Operator and ingress controllers.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.WebLogic Deploy Tooling (WDT) and WebLogic Image Tool (WIT) are bundled with the WKT UI application. These tools are:
+Use Help
> Check For Updates
periodically to make sure you are using the latest versions of these
+bundled tools.
The WebLogic Kubernetes Toolkit UI is a desktop application designed to help WebLogic users move their applications to run in a Kubernetes environment.
+Download and install the latest LTS version of node.js
from https://nodejs.org/en/download/.
If you rely on a proxy server to reach the Internet, set these five 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>
+
Open a command line and run the following command to update the version of npm
to the latest:
sudo npm install --global npm
+
Set up your global git configuration by running the following commands:
+git config --global user.name "<your real name>"
+git config --global user.email "<your-oracle-email-address>"
+git config --global core.ignoreCase false
+
This last command is critical if you are developing on either Windows or macOS. Yes, the macOS file system +is, by default, case-insensitive!
+Clone the git repository on GitHub at https://github.com/oracle/weblogic-toolkit-ui.
+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.
Open a command line in the weblogic-toolkit-ui/electron
directory and run npm run install-tools
.
Open a command line in the weblogic-toolkit-ui/webui
directory and run npm start
.
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
.
weblogic-toolkit-ui/electron
directory and run npm run build
.weblogic-toolkit-ui/dist
directory.weblogic-toolkit-ui/webui
directory and run npm run build:release
.weblogic-toolkit-ui/scripts
directory, run ./devBuildLinuxInstallers.sh
.weblogic-toolkit-ui/dist
directory.Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
-``` - -## Emphasis - -### Bold - -For emphasizing a snippet of text with a heavier font-weight. - -The following snippet of text is **rendered as bold text**. - -```markdown -**rendered as bold text** -``` - -renders to: - - -**rendered as bold text** - - -and this HTML - -```html -rendered as bold text -``` - -### Italics - -For emphasizing a snippet of text with italics. - -The following snippet of text is _rendered as italicized text_. - -```markdown -_rendered as italicized text_ -``` - -renders to: - - -_rendered as italicized text_ - - -and this HTML: - -```html -rendered as italicized text -``` - -### Strikethrough - -In GFM (GitHub flavored Markdown) you can do strikethroughs. - -```markdown -~~Strike through this text.~~ -``` - -Which renders to: - -~~Strike through this text.~~ - -HTML: - -```html ---``` - -Blockquotes can also be nested: - -```markdown -> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. -> -> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. -> -> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. -``` - -Renders to: - -> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. -> -> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. -> -> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. - -## Notices - -{{% notice note %}} -The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) -{{% /notice %}} - -## Lists - -### Unordered - -A list of items in which the order of the items does not explicitly matter. - -You may use any of the following symbols to denote bullets for each list item: - -```markdown -* valid bullet -- valid bullet -+ valid bullet -``` - -For example - -```markdown -+ Lorem ipsum dolor sit amet -+ Consectetur adipiscing elit -+ Integer molestie lorem at massa -+ Facilisis in pretium nisl aliquet -+ Nulla volutpat aliquam velit - - Phasellus iaculis neque - - Purus sodales ultricies - - Vestibulum laoreet porttitor sem - - Ac tristique libero volutpat at -+ Faucibus porta lacus fringilla vel -+ Aenean sit amet erat nunc -+ Eget porttitor lorem -``` - -Renders to: - - -+ Lorem ipsum dolor sit amet -+ Consectetur adipiscing elit -+ Integer molestie lorem at massa -+ Facilisis in pretium nisl aliquet -+ Nulla volutpat aliquam velit - - Phasellus iaculis neque - - Purus sodales ultricies - - Vestibulum laoreet porttitor sem - - Ac tristique libero volutpat at -+ Faucibus porta lacus fringilla vel -+ Aenean sit amet erat nunc -+ Eget porttitor lorem - - -And this HTML - -```html -Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
-
In this example, <section></section>
should be wrapped as code.
-
- // Some comments
- line 1 of code
- line 2 of code
- line 3 of code
-
-
-```
-
-### Block code "fences"
-
-Use "fences" ```` ``` ```` to block in multiple lines of code.
-
-```markdown
-Sample text here...
-```
-
-HTML:
-
-```html
-
- Sample text here...
-
-```
-
-### Syntax highlighting
-
-GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML.
-
-See [Code Highlighting]({{< ref "syntaxhighlight.md" >}}) for additional documentation.
-
-For example, to apply syntax highlighting to JavaScript code:
-
-```plaintext
- ```js
- grunt.initConfig({
- assemble: {
- options: {
- assets: 'docs/assets',
- data: 'src/data/*.{json,yml}',
- helpers: 'src/custom-helpers.js',
- partials: ['src/partials/**/*.{hbs,md}']
- },
- pages: {
- options: {
- layout: 'default.hbs'
- },
- files: {
- './': ['src/templates/pages/index.hbs']
- }
- }
- }
- };
- ```
-```
-
-Renders to:
-
-```js
-grunt.initConfig({
- assemble: {
- options: {
- assets: 'docs/assets',
- data: 'src/data/*.{json,yml}',
- helpers: 'src/custom-helpers.js',
- partials: ['src/partials/**/*.{hbs,md}']
- },
- pages: {
- options: {
- layout: 'default.hbs'
- },
- files: {
- './': ['src/templates/pages/index.hbs']
- }
- }
- }
-};
-```
-
-## Tables
-
-Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
-
-```markdown
-| Option | Description |
-| ------ | ----------- |
-| data | path to data files to supply the data that will be passed into templates. |
-| engine | engine to be used for processing templates. Handlebars is the default. |
-| ext | extension to be used for dest files. |
-```
-
-Renders to:
-
-| Option | Description |
-| ------ | ----------- |
-| data | path to data files to supply the data that will be passed into templates. |
-| engine | engine to be used for processing templates. Handlebars is the default. |
-| ext | extension to be used for dest files. |
-
-And this HTML:
-
-```html
-Option | -Description | -
---|---|
data | -path to data files to supply the data that will be passed into templates. | -
engine | -engine to be used for processing templates. Handlebars is the default. | -
ext | -extension to be used for dest files. | -
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
-``` - -## Emphasis - -### Bold -For emphasizing a snippet of text with a heavier font-weight. - -The following snippet of text is **rendered as bold text**. - -```markdown -**rendered as bold text** -``` -renders to: - -**rendered as bold text** - -and this HTML - -```html -rendered as bold text -``` - -### Italics -For emphasizing a snippet of text with italics. - -The following snippet of text is _rendered as italicized text_. - -```markdown -_rendered as italicized text_ -``` - -renders to: - -_rendered as italicized text_ - -and this HTML: - -```html -rendered as italicized text -``` - - -### strikethrough -In GFM (GitHub flavored Markdown) you can do strikethroughs. - -```markdown -~~Strike through this text.~~ -``` -Which renders to: - -~~Strike through this text.~~ - -HTML: - -```html ---``` - -Blockquotes can also be nested: - -```markdown -> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. -> -> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. -> -> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. -``` - -Renders to: - -> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. -> -> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. -> -> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. - -## Notices - -{{% notice note %}} -The old mechanism for notices overriding the block quote syntax (`>>>`) has been deprecated. Notices are now handled via a dedicated plugin called [Markdown Notices](https://github.com/getgrav/grav-plugin-markdown-notices) -{{% /notice %}} - -## Lists - -### Unordered -A list of items in which the order of the items does not explicitly matter. - -You may use any of the following symbols to denote bullets for each list item: - -```markdown -* valid bullet -- valid bullet -+ valid bullet -``` - -For example - -```markdown -+ Lorem ipsum dolor sit amet -+ Consectetur adipiscing elit -+ Integer molestie lorem at massa -+ Facilisis in pretium nisl aliquet -+ Nulla volutpat aliquam velit - - Phasellus iaculis neque - - Purus sodales ultricies - - Vestibulum laoreet porttitor sem - - Ac tristique libero volutpat at -+ Faucibus porta lacus fringilla vel -+ Aenean sit amet erat nunc -+ Eget porttitor lorem -``` -Renders to: - -+ Lorem ipsum dolor sit amet -+ Consectetur adipiscing elit -+ Integer molestie lorem at massa -+ Facilisis in pretium nisl aliquet -+ Nulla volutpat aliquam velit - - Phasellus iaculis neque - - Purus sodales ultricies - - Vestibulum laoreet porttitor sem - - Ac tristique libero volutpat at -+ Faucibus porta lacus fringilla vel -+ Aenean sit amet erat nunc -+ Eget porttitor lorem - -And this HTML - -```html -Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
-
In this example, <section></section>
should be wrapped with code.
- // Some comments - line 1 of code - line 2 of code - line 3 of code -- -Renders to: - - // Some comments - line 1 of code - line 2 of code - line 3 of code - -HTML: - -```html -
-
- // Some comments
- line 1 of code
- line 2 of code
- line 3 of code
-
-
-```
-
-
-### Block code "fences"
-
-Use "fences" ```` ``` ```` to block in multiple lines of code.
-
--``` markup -Sample text here... -``` -- - -``` -Sample text here... -``` - -HTML: - -```html -
- Sample text here...
-
-```
-
-### Syntax highlighting
-
-GFM, or "GitHub Flavored Markdown" also supports syntax highlighting. To activate it, simply add the file extension of the language you want to use directly after the first code "fence", ` ```js `, and syntax highlighting will automatically be applied in the rendered HTML. For example, to apply syntax highlighting to JavaScript code:
-
--```js -grunt.initConfig({ - assemble: { - options: { - assets: 'docs/assets', - data: 'src/data/*.{json,yml}', - helpers: 'src/custom-helpers.js', - partials: ['src/partials/**/*.{hbs,md}'] - }, - pages: { - options: { - layout: 'default.hbs' - }, - files: { - './': ['src/templates/pages/index.hbs'] - } - } - } -}; -``` -- -Renders to: - -```js -grunt.initConfig({ - assemble: { - options: { - assets: 'docs/assets', - data: 'src/data/*.{json,yml}', - helpers: 'src/custom-helpers.js', - partials: ['src/partials/**/*.{hbs,md}'] - }, - pages: { - options: { - layout: 'default.hbs' - }, - files: { - './': ['src/templates/pages/index.hbs'] - } - } - } -}; -``` - -## Tables -Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned. - - -```markdown -| Option | Description | -| ------ | ----------- | -| data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | -``` - -Renders to: - -| Option | Description | -| ------ | ----------- | -| data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | - -And this HTML: - -```html -
Option | -Description | -
---|---|
data | -path to data files to supply the data that will be passed into templates. | -
engine | -engine to be used for processing templates. Handlebars is the default. | -
ext | -extension to be used for dest files. | -
- Le site fonctionne. Ne pas oublier de personaliser cette page avec votre propre contenu. 3 manières de faire : -
-- The site is working. Don't forget to customize this homepage with your own. You typically have 3 choices : -
-