Working on Zowe Client Kotlin SDK docs

Signed-off-by: Uladzislau <[email protected]>

404.html

@@ -0,0 +1,25 @@
+---
+id: not-found
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container-404 {
+    margin: 10px auto;
+    text-align: center;
+  }
+  .h1-404 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container-404">
+  <h1 class="h1-404">404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

Gemfile

@@ -0,0 +1,37 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.3.1"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem "webrick", "~> 1.7"
+
+gem 'bootstrap', '~> 5.2.3'

Gemfile.lock

@@ -0,0 +1,164 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    autoprefixer-rails (10.4.7.0)
+      execjs (~> 2)
+    bootstrap (5.2.3)
+      autoprefixer-rails (>= 9.1.0)
+      popper_js (>= 2.11.6, < 3)
+      sassc-rails (>= 2.0.0)
+    builder (3.2.4)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    erubi (1.11.0)
+    eventmachine (1.2.7)
+    eventmachine (1.2.7-x86-mingw32)
+    execjs (2.8.1)
+    ffi (1.15.5-x64-mingw-ucrt)
+    ffi (1.15.5-x86-mingw32)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mercenary (0.4.0)
+    method_source (1.0.0)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (5.16.3)
+    nokogiri (1.13.9-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.13.9-x86-mingw32)
+      racc (~> 1.4)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    popper_js (2.11.6)
+    public_suffix (5.0.0)
+    racc (1.6.1)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (4.0.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-rails (2.1.2)
+      railties (>= 4.0.0)
+      sassc (>= 2.0)
+      sprockets (> 3.0)
+      sprockets-rails
+      tilt
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2022.7)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (2.3.0)
+    wdm (0.1.1)
+    webrick (1.7.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x64-mingw-ucrt
+  x86-mingw32
+
+DEPENDENCIES
+  bootstrap (~> 5.2.3)
+  http_parser.rb (~> 0.6.0)
+  jekyll (~> 4.3.1)
+  jekyll-feed (~> 0.12)
+  minima (~> 2.5)
+  tzinfo (>= 1, < 3)
+  tzinfo-data
+  wdm (~> 0.1.1)
+  webrick (~> 1.7)
+
+BUNDLED WITH
+   2.3.26

README.md

@@ -1,5 +1,14 @@
+---
+id: home
+layout: default
+title: Home
+permalink: /
+---
+
 # Zowe® Сlient Kotlin SDK
 
+# [Click here](https://zowe.github.io/zowe-client-kotlin-sdk/docs) to go to the Zowe Client Kotlin SDK source code docs
+
 Zowe Client Kotlin SDK cover z/OSMF REST API with Kotlin object-oriented code using Retrofit2. It provides functionality to send HTTP requests to z/OSMF using Kotlin functions.
 
 ## Installation
@@ -11,6 +20,7 @@ To install this library in your project, use one of build tools like Maven, Grad
 To add the SDK as a Maven dependency:
 
 1. Declare a Zowe JFrog artifactory as a custom repository to fetch from:
+
 ```xml
 <project>
 ...
@@ -26,6 +36,7 @@ To add the SDK as a Maven dependency:
 ```
 
 2. Add a new Maven dependency:
+
 ```xml
 <project>
   ...
@@ -45,6 +56,7 @@ To add the SDK as a Maven dependency:
 To add the SDK as a Gradle dependency:
 
 1. Declare a Zowe JFrog artifactory as a custom repository to fetch from:
+
 ```kotlin
 repositories {
   ...
@@ -56,6 +68,7 @@ repositories {
 ```
 
 2. Add a new Gradle dependency:
+
 ```kotlin
 // change the <version> to the actual version of the Zowe Client Kotlin SDK
 val zoweKotlinSdkVersion = <version>
@@ -70,6 +83,7 @@ dependencies {
 ### How to use the SDK in your project
 
 To use the Zowe Client Kotlin SDK after it is added as a dependency in your project, simply import any of the needed packages:
+
 ```kotlin
 ...
 import org.zowe.kotlinsdk
@@ -107,6 +121,7 @@ The raw APIs provide descriptions with headers and body parameters to issue a re
 
 To customize the request triggering and response handling:
 1. Import the necessary raw API to cover, as well as **Retrofit2 API builder**:
+
 ```kotlin
 ...
 // Import DataAPI and API wrapper
@@ -120,6 +135,7 @@ import org.zowe.kotlinsdk.buildApiWithBytesConverter
 ```
 
 2. Wrap the API with the **Retrofit2 API builder**
+
 ```kotlin
 ...
 // Build DataAPI wrapper
@@ -128,6 +144,7 @@ val datasetsApi = buildApi(<zosmf-url>, <okhttp-client>, DataAPI::class.java)
 ```
 
 3. Use the API wrapper and process the response
+
 ```kotlin
 ...
 // Declare the request
@@ -168,17 +185,20 @@ This package provides the default API isage implementation that is available to
 
 As the example of how to use the default implementation:
 1. Import **ZOSConnection** and other classes with the functionality needed:
+
 ```kotlin
 import org.zowe.kotlinsdk.zowe.client.sdk.core.ZOSConnection
 import org.zowe.kotlinsdk.zowe.client.sdk.zosfiles.ZosDsn
 ```
 
 2. Create a **ZOSConnection** instance:
+
 ```kotlin
 val zosConnection = ZOSConnection("<host>", "<port>", "<username>", "<password>", "http(s)")
 ```
 
 3. Create the functionality class instance and trigger the function needed:
+
 ```kotlin
 val result = ZosDsn(zosConnection).createDsn("<dsn>", <CreateDataset cls instance>)
 ```
@@ -212,6 +232,7 @@ Before running integration tests, you need three variables to be set up:
 - **``ZOSMF_TEST_PASSWORD``** - a user password to run the tests
 
 To run the integration tests:
+
 ```shell
 ./gradlew intTest
 ```
@@ -221,6 +242,7 @@ To run the integration tests:
 We use **[Dokka](https://github.com/Kotlin/dokka)** to generate the SDK documentation.
 
 To generate the docs, run:
+
 ```shell
 ./gradlew dokkaHtml
 ```
@@ -239,6 +261,7 @@ The rules and commands below describe how to publish artifacts for the Zowe Clie
 1. The version of the built SDK will be in a **SemVer** format. To provide a build that is not yet ready to be publicly used, add the **-rc.n** at the end of the version, where **n** is **the next release candidate**.
 2. Provide **`zowe.deploy.username`** and **`zowe.deploy.password`** as the parameters of the **`release`** command to specify the credentials to the [Zowe Artifactory](https://zowe.jfrog.io/), as well as the **`artifactory_user`** and the **`artifactory_password`** (generally, the credentials might be the same, but the variables are different for the different tasks during the release process).
 Example:
+
 ```shell
 ./gradlew release -Pzowe.deploy.username=$ARTIFACTORY_USERNAME -Pzowe.deploy.password=$ARTIFACTORY_PASSWORD -Partifactory_user=$ARTIFACTORY_USERNAME -Partifactory_password=$ARTIFACTORY_USERNAME
 ```

_config.yml

@@ -0,0 +1,6 @@
+title: Zowe Client Kotlin SDK documentation
+description: >-
+  Welcome to the documentation page
+baseurl: "/zowe-client-kotlin-sdk"
+url: ""
+github_username:  jekyll

_includes/contents.html

@@ -0,0 +1,36 @@
+<!--
+ This program and the accompanying materials are made available under the terms of the
+ Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ https://www.eclipse.org/legal/epl-v20.html
+
+ SPDX-License-Identifier: EPL-2.0
+
+ Copyright IBA Group 2020
+-->
+
+<style>
+  .custom-list {
+    list-style: none;
+    padding-left: 0;
+    margin-bottom: 0;
+  }
+  .custom-list-elem a {
+    color: inherit;
+  }
+  .custom-list-elem a:not(:hover) {
+    text-decoration: none;
+  }
+</style>
+{% assign page_contents_elem = site.data.contents | where: "page_id", page.id | first %}
+{% if page_contents_elem %}
+  <div class="text-muted">
+    <strong class="d-none d-md-block h6 mb-2">Contents:</strong>
+    <nav>
+      <ul class="custom-list">
+        {% for page_contents in page_contents_elem.page_contents %}
+          <li class="custom-list-elem"><a href="#{{ page_contents.section }}">{{ page_contents.name }}</a></li>
+        {% endfor %}
+      </ul>
+    </nav>
+  </div>
+{% endif %}

_includes/head.html

@@ -0,0 +1 @@
+<link rel="icon" type="image/png" href="{{ '/assets/images/zowe-icon.png' | relative_url }}">