Skip to content

docs: webpage docs skeleton #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
==========
Expand Down
4 changes: 3 additions & 1 deletion docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,13 @@ GEM
unicode-display_width (1.7.0)

PLATFORMS
ruby
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jekyll is in ruby this was automaitcally added by bundler, not sure why

universal-darwin-20
x86_64-linux

DEPENDENCIES
jekyll (~> 4.2)
jekyll-github-metadata

BUNDLED WITH
2.2.22
2.2.30
11 changes: 9 additions & 2 deletions docs/_data/sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Navbar menu navigation links
- title: Intro to Operators
url: /docs/intro-operators
- title: Getting Started
url: /docs/getting-started
- title: Contributing
url: /docs/contributing
- title: How to use Samples
url: /docs/using-samples
- title: Features
url: /docs/features
- title: FAQ
url: /docs/faq
- title: Contributing
url: /docs/contributing

7 changes: 7 additions & 0 deletions docs/documentation/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: FAQ
description: Frequently asked questions
layout: docs
permalink: /docs/faq
---

39 changes: 39 additions & 0 deletions docs/documentation/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
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

## Handling Related Events with Event Sources

### Caching and Event Sources

### The CustomResourceEventSource

### Built-in Event Sources

## Monitoring with Micrometer





12 changes: 12 additions & 0 deletions docs/documentation/intro-operators.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Introduction to Operators
description: Introduction to Operators
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.