Skip to content

Commit c0004c5

Browse files
csviriadam-sandor
authored andcommitted
docs: webpage docs skeleton (#631)
1 parent 6585101 commit c0004c5

File tree

6 files changed

+71
-3
lines changed

6 files changed

+71
-3
lines changed

Diff for: README.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
Build Kubernetes Operators in Java without hassle. Inspired
77
by [operator-sdk](https://github.com/operator-framework/operator-sdk).
88

9+
Our webpage with documentation is getting better every day: https://javaoperatorsdk.io/
910

1011
Table of Contents
1112
==========

Diff for: docs/Gemfile.lock

+3-1
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,13 @@ GEM
7474
unicode-display_width (1.7.0)
7575

7676
PLATFORMS
77+
ruby
7778
universal-darwin-20
79+
x86_64-linux
7880

7981
DEPENDENCIES
8082
jekyll (~> 4.2)
8183
jekyll-github-metadata
8284

8385
BUNDLED WITH
84-
2.2.22
86+
2.2.30

Diff for: docs/_data/sidebar.yml

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
# Navbar menu navigation links
2+
- title: Intro to Operators
3+
url: /docs/intro-operators
24
- title: Getting Started
35
url: /docs/getting-started
4-
- title: Contributing
5-
url: /docs/contributing
66
- title: How to use Samples
77
url: /docs/using-samples
8+
- title: Features
9+
url: /docs/features
10+
- title: FAQ
11+
url: /docs/faq
12+
- title: Contributing
13+
url: /docs/contributing
14+

Diff for: docs/documentation/faq.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: FAQ
3+
description: Frequently asked questions
4+
layout: docs
5+
permalink: /docs/faq
6+
---
7+

Diff for: docs/documentation/features.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Features
3+
description: Features of the SDK
4+
layout: docs
5+
permalink: /docs/features
6+
---
7+
8+
# Features
9+
10+
## Controller Registration
11+
12+
## Configurations
13+
14+
## Finalizers
15+
16+
### When not to Use Finalizers
17+
18+
## Automatic Retries on Error
19+
20+
### Correctness and automatic retry
21+
22+
## Re-Scheduling Execution
23+
24+
## Retry and Re-Scheduling Common Behavior
25+
26+
## Handling Related Events with Event Sources
27+
28+
### Caching and Event Sources
29+
30+
### The CustomResourceEventSource
31+
32+
### Built-in Event Sources
33+
34+
## Monitoring with Micrometer
35+
36+
37+
38+
39+

Diff for: docs/documentation/intro-operators.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Introduction to Operators
3+
description: Introduction to Operators
4+
layout: docs
5+
permalink: /docs/intro-operators
6+
---
7+
8+
# Introduction To Operators
9+
10+
On this page we selected a collection of resources to introduce you to the concepts of Kubernetes Operators.
11+
12+

0 commit comments

Comments
 (0)