Skip to content

Commit 88d693a

Browse files
robertpatrickrobertpatrick
committed
setting up doc infrastructure
1 parent f3e0dc3 commit 88d693a

File tree

244 files changed

+10636
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

244 files changed

+10636
-0
lines changed

‎.github/workflows/publish-github-pages.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Copyright (c) 2021, Oracle and/or its affiliates.
2+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
3+
#
4+
# Description
5+
# Use Hugo to build static site and publish to gh-pages
6+
#
7+
name: "PublishGitHubPages"
8+
9+
on:
10+
push:
11+
branches: [ main ]
12+
schedule:
13+
- cron: '15 3 * * 1'
14+
15+
defaults:
16+
run:
17+
shell: bash
18+
19+
jobs:
20+
publish:
21+
name: Publish
22+
runs-on: ubuntu-latest
23+
24+
steps:
25+
- name: Checkout main
26+
uses: actions/[email protected]
27+
with:
28+
ref: main
29+
fetch-depth: 32
30+
path: main
31+
32+
- name: Checkout gh-pages
33+
uses: actions/[email protected]
34+
with:
35+
ref: gh-pages
36+
path: gh-pages
37+
token: ${{ secrets.PUBLISH_SECRET }}
38+
39+
- name: Verify changes to documentation present
40+
id: change-check
41+
run: |
42+
cd $GITHUB_WORKSPACE/main
43+
X=`git diff HEAD~1 --name-only | { grep "^documentation" || test $? = 1; } | wc -l`
44+
if [ $X == "0" ]; then
45+
echo 'No changes to the documenation'
46+
else
47+
echo '::set-output name=DOCUMENTATION_CHANGED::true'
48+
fi
49+
- name: Build and publish site
50+
if: ${{ steps.change-check.outputs.DOCUMENTATION_CHANGED == 'true' }}
51+
run: |
52+
curl -fL -o hugo.tar.gz "https://github.com/gohugoio/hugo/releases/download/v0.88.1/hugo_0.88.1_Linux-64bit.tar.gz"
53+
tar -zxf hugo.tar.gz
54+
export PATH="$PWD:$PATH"
55+
mkdir $GITHUB_WORKSPACE/WORK
56+
cd $GITHUB_WORKSPACE/main/documentation
57+
./publish.sh -o $GITHUB_WORKSPACE/WORK
58+
cd $GITHUB_WORKSPACE/gh-pages
59+
rm -Rf *
60+
cp -R $GITHUB_WORKSPACE/WORK/* .
61+
git config --global user.name "github-actions[bot]"
62+
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
63+
git add --all
64+
git commit -m "Documentation update from publish GitHub Action"
65+
git push origin gh-pages

‎documentation/1.0/archetypes/default.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: false
5+
---
6+

‎documentation/1.0/config.toml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# analytics
2+
googleAnalytics = "UA-129126578-2"
3+
4+
baseURL = '/weblogic-toolikit-ui/'
5+
languageCode = 'en-us'
6+
title = 'WebLogic Kubernetes Toolkit UI'
7+
8+
# Change the default theme to be use when building the site with Hugo
9+
theme = 'learn'
10+
11+
publishDir = "docs"
12+
13+
# For search functionality
14+
[outputs]
15+
home = [ "HTML", "RSS", "JSON"]
16+
17+
[params]
18+
# disable the copy to clipboard links
19+
disableInlineCopyToClipBoard = true

‎documentation/1.0/content/_index.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "WebLogic Kubernetes Toolkit UI Documentation"
3+
date: 2021-10-14T11:13:41-05:00
4+
draft: true
5+
---
6+
7+
# WebLogic Kubernetes Toolkit UI Documentation
8+
The WebLogic Kubernetes Toolkit (WKT) is a collection of open source tools that help you provision WebLogic-based
9+
applications to run in Linux containers on a Kubernetes cluster. WKT includes the following tools:
10+
11+
- [WebLogic Deploy Tooling (WDT)](https://github.com/oracle/weblogic-deploy-tooling) - A set of single-purpose,
12+
lifecycle tools that operate off of a single metadata model representation of a WebLogic domain.
13+
- [WebLogic Image Tool (WIT)](https://github.com/oracle/weblogic-image-tool) - A tool for creating Linux container
14+
images for running WebLogic domains.
15+
- [WebLogic Kubernetes Operator (WKO)](https://github.com/oracle/weblogic-kubernetes-operator) - A Kubernetes operator
16+
that allows WebLogic domains to run natively in a Kubernetes cluster.
17+
18+
The WKT UI provides a graphical user interface that wraps the WKT tools, Docker, Helm, and the Kubernetes client
19+
(`kubectl`) and helps guide you through the process of creating and modifying a model of your WebLogic domain, creating
20+
a Linux container image to use to run the domain, and setting up and deploying the software and configuration
21+
necessary to deploy and access the domain in your Kubernetes cluster.
22+
23+
## Get Started
24+
25+
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.
26+
Simply run the appropriate installer for your operating system.
27+
28+
29+
Initial launch of the application displays a thorough "Introduction" to the WKT UI. Step through
30+
it or dismiss it; you can peruse it at any time using `Help > Show Introduction`.
31+
32+
## About the Documentation
33+
For detailed user information, read the following:
34+
35+
- WebLogic Kubernetes Toolkit UI [Prerequisites](site/prerequisites.md)
36+
- About the [WKT UI Application](site/setup.md)
37+
- [Navigate the WKT UI](site/project-settings.md)
38+
- [Model](site/model.md)
39+
- [Image](site/image.md)
40+
- [Kubernetes](site/k8s-client-config.md)
41+
- [Verrazzano](site/verrazzano.md)
42+
43+
For developer information, see [WebLogic Kubernetes Toolkit UI Project](site/developer.md).
44+
45+
## Get Help
46+
47+
We have a closely monitored public Slack channel where you can get in touch with us to ask questions about using the
48+
WebLogic Toolkit UI or give us feedback or suggestions about what features and improvements you would like to see.
49+
We would love to hear from you.
50+
51+
## Related Projects
52+
For detailed documentation and access to WebLogic Toolkit-related projects, see:
53+
54+
- [WebLogic Kubernetes Operator](https://oracle.github.io/weblogic-kubernetes-operator/)
55+
- [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/)
56+
- [WebLogic Image Tool](https://oracle.github.io/weblogic-image-tool/)
57+

‎documentation/1.0/runlocal.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash
2+
#
3+
# Copyright (c) 2019, 2021, Oracle and/or its affiliates.
4+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
5+
#
6+
# 1313 is the hugo default port
7+
port=${1:-1313}
8+
9+
hugo server -b http://localhost:$port/weblogic-toolkit-ui -D -p $port

‎documentation/1.0/runpublic.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash
2+
3+
# Copyright (c) 2019, 2021, Oracle and/or its affiliates.
4+
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
5+
6+
# 1313 is the hugo default port
7+
port=${1:-1313}
8+
9+
hugo server -b http://$(hostname).$(dnsdomainname):$port/weblogic-toolkit-ui -D --bind=$(hostname).$(dnsdomainname) -p $port

‎documentation/1.0/static/images/logo.png

91.7 KB
Loading

‎documentation/1.0/themes/learn/.editorconfig

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# https://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
indent_size = 2
9+
indent_style = space
10+
trim_trailing_whitespace = true
11+
12+
[*.js]
13+
insert_final_newline = true
14+
15+
[*.md]
16+
trim_trailing_whitespace = false

‎documentation/1.0/themes/learn/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.DS_Store
2+
public/
3+
exampleSite/public

‎documentation/1.0/themes/learn/.grenrc.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
dataSource: "prs"
3+
prefix: "v"
4+
onlyMilestones: false
5+
changelogFilename: "CHANGELOG.md"
6+
includeMessages: "all"
7+
ignoreIssuesWith:
8+
- "support"
9+
ignoreLabels:
10+
- "duplicate"
11+
- "invalid"
12+
- "wontfix"
13+
groupBy:
14+
New features:
15+
- "feature"
16+
Bug Fixes:
17+
- "bug"
18+
Enhancements:
19+
- "enhancement"
20+
Internationalisation:
21+
- "i18n"
22+
Theme Meta:
23+
- "meta"
24+
Uncategorised:
25+
- "closed"

0 commit comments

Comments
 (0)