From 0aca93ae41560ecfb157a859cfc75b4e50734018 Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Wed, 27 Oct 2021 16:55:58 +0200
Subject: [PATCH 1/5] docs: webpage skeleton
---
docs/Gemfile.lock | 4 +++-
docs/_data/sidebar.yml | 11 +++++++++--
docs/documentation/faq.md | 9 +++++++++
docs/documentation/features-and-behavior.md | 8 ++++++++
docs/documentation/intro-operators.md | 9 +++++++++
5 files changed, 38 insertions(+), 3 deletions(-)
create mode 100644 docs/documentation/faq.md
create mode 100644 docs/documentation/features-and-behavior.md
create mode 100644 docs/documentation/intro-operators.md
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
index e8ee3a5427..605cd1d411 100644
--- a/docs/Gemfile.lock
+++ b/docs/Gemfile.lock
@@ -74,11 +74,13 @@ GEM
unicode-display_width (1.7.0)
PLATFORMS
+ ruby
universal-darwin-20
+ x86_64-linux
DEPENDENCIES
jekyll (~> 4.2)
jekyll-github-metadata
BUNDLED WITH
- 2.2.22
+ 2.2.30
diff --git a/docs/_data/sidebar.yml b/docs/_data/sidebar.yml
index 96266dd842..2596f92f17 100644
--- a/docs/_data/sidebar.yml
+++ b/docs/_data/sidebar.yml
@@ -1,7 +1,14 @@
# Navbar menu navigation links
- title: Getting Started
url: /docs/getting-started
- - title: Contributing
- url: /docs/contributing
- title: How to use Samples
url: /docs/using-samples
+ - title: Intro to Operators
+ url: /docs/intro-operators
+ - title: Features and Behavior
+ url: /docs/features-and-behavior
+ - title: FAQ
+ url: /docs/faq
+ - title: Contributing
+ url: /docs/contributing
+
diff --git a/docs/documentation/faq.md b/docs/documentation/faq.md
new file mode 100644
index 0000000000..f383f7c9f0
--- /dev/null
+++ b/docs/documentation/faq.md
@@ -0,0 +1,9 @@
+---
+title: FAQ
+description: Frequently asked questions
+layout: docs
+permalink: /docs/faq
+---
+
+
+TODO
\ No newline at end of file
diff --git a/docs/documentation/features-and-behavior.md b/docs/documentation/features-and-behavior.md
new file mode 100644
index 0000000000..b85ba6a450
--- /dev/null
+++ b/docs/documentation/features-and-behavior.md
@@ -0,0 +1,8 @@
+---
+title: Feature and Behavior
+description: Feature and Behavior
+layout: docs
+permalink: /docs/features-and-behavior
+---
+
+TODO
\ No newline at end of file
diff --git a/docs/documentation/intro-operators.md b/docs/documentation/intro-operators.md
new file mode 100644
index 0000000000..ae0e510093
--- /dev/null
+++ b/docs/documentation/intro-operators.md
@@ -0,0 +1,9 @@
+---
+title: Introduction to Operators
+description: Introduction to Operators
+layout: docs
+permalink: /docs/intro-operators
+---
+
+
+TODO
\ No newline at end of file
From dadfd8f80fde22ac48ca5127abcc20ee266c993c Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Thu, 28 Oct 2021 13:20:13 +0200
Subject: [PATCH 2/5] doc: structure of docs
---
docs/_data/sidebar.yml | 8 ++---
docs/documentation/faq.md | 2 --
docs/documentation/features-and-behavior.md | 8 -----
docs/documentation/features.md | 35 +++++++++++++++++++++
docs/documentation/intro-operators.md | 5 ++-
5 files changed, 43 insertions(+), 15 deletions(-)
delete mode 100644 docs/documentation/features-and-behavior.md
create mode 100644 docs/documentation/features.md
diff --git a/docs/_data/sidebar.yml b/docs/_data/sidebar.yml
index 2596f92f17..7d88cde491 100644
--- a/docs/_data/sidebar.yml
+++ b/docs/_data/sidebar.yml
@@ -1,12 +1,12 @@
# Navbar menu navigation links
+ - title: Intro to Operators
+ url: /docs/intro-operators
- title: Getting Started
url: /docs/getting-started
- title: How to use Samples
url: /docs/using-samples
- - title: Intro to Operators
- url: /docs/intro-operators
- - title: Features and Behavior
- url: /docs/features-and-behavior
+ - title: Features
+ url: /docs/features
- title: FAQ
url: /docs/faq
- title: Contributing
diff --git a/docs/documentation/faq.md b/docs/documentation/faq.md
index f383f7c9f0..f4127b39fe 100644
--- a/docs/documentation/faq.md
+++ b/docs/documentation/faq.md
@@ -5,5 +5,3 @@ layout: docs
permalink: /docs/faq
---
-
-TODO
\ No newline at end of file
diff --git a/docs/documentation/features-and-behavior.md b/docs/documentation/features-and-behavior.md
deleted file mode 100644
index b85ba6a450..0000000000
--- a/docs/documentation/features-and-behavior.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: Feature and Behavior
-description: Feature and Behavior
-layout: docs
-permalink: /docs/features-and-behavior
----
-
-TODO
\ No newline at end of file
diff --git a/docs/documentation/features.md b/docs/documentation/features.md
new file mode 100644
index 0000000000..bcf7db2b5c
--- /dev/null
+++ b/docs/documentation/features.md
@@ -0,0 +1,35 @@
+---
+title: Features
+description: Features of the SDK
+layout: docs
+permalink: /docs/features
+---
+
+# Features
+
+## Controller Registration
+
+## Configurations
+
+## Finalizers
+
+### When not to Use Finalizers
+
+## Automatic Retries on Error
+
+### Correctness and automatic retry
+
+## Re-Scheduling Execution
+
+## Retry and Re-Scheduling Common Behavior
+
+## Event Sources
+
+### Caching and Event Sources
+
+### The CustomResourceEventSource
+
+### Built-in Event Sources
+
+
+
diff --git a/docs/documentation/intro-operators.md b/docs/documentation/intro-operators.md
index ae0e510093..13a9812df1 100644
--- a/docs/documentation/intro-operators.md
+++ b/docs/documentation/intro-operators.md
@@ -5,5 +5,8 @@ layout: docs
permalink: /docs/intro-operators
---
+# Introduction To Operators
+
+On this page we selected a collection of resources to introduce you to the concepts of Kubernetes Operators.
+
-TODO
\ No newline at end of file
From 76a60f8bf72e9e0535d9c98d49ff3a7c7432753d Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Thu, 28 Oct 2021 18:12:57 +0200
Subject: [PATCH 3/5] fix: event sources section name
---
docs/documentation/features.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/documentation/features.md b/docs/documentation/features.md
index bcf7db2b5c..1fcfe726f0 100644
--- a/docs/documentation/features.md
+++ b/docs/documentation/features.md
@@ -23,7 +23,7 @@ permalink: /docs/features
## Retry and Re-Scheduling Common Behavior
-## Event Sources
+## Handling Related Events with Event Sources
### Caching and Event Sources
From 37b32881c11f68a3ab6e0f9fd8adb05176948f30 Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Fri, 29 Oct 2021 09:11:17 +0200
Subject: [PATCH 4/5] docs: added monitoring section
---
docs/documentation/features.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/documentation/features.md b/docs/documentation/features.md
index 1fcfe726f0..7f77bcbbde 100644
--- a/docs/documentation/features.md
+++ b/docs/documentation/features.md
@@ -31,5 +31,9 @@ permalink: /docs/features
### Built-in Event Sources
+## Monitoring with Micrometer
+
+
+
From 4c9ea36c9773263a8a774127dce3e5cc4de97afa Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Fri, 29 Oct 2021 10:05:43 +0200
Subject: [PATCH 5/5] fix: link to the webpage
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index 2988e55408..d42c45b7a0 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,7 @@
Build Kubernetes Operators in Java without hassle. Inspired
by [operator-sdk](https://github.com/operator-framework/operator-sdk).
+Our webpage with documentation is getting better every day: https://javaoperatorsdk.io/
Table of Contents
==========