Skip to content

Commit 7f266fc

Browse files
committed
link to docs from user guide
1 parent ac2cc18 commit 7f266fc

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ Feature we would like to implement and invite the community to help us implement
2424
* Configurable Retry Handling
2525
* Smart Event Processing Scheduling
2626

27+
## User Guide
28+
29+
You can find detailed documentation [here](docs/DOCS.md).
30+
Note that these docs are currently in progress.
31+
2732
## Usage
2833

2934
We have several sample Operators under the samples directory:

docs/DOCS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,20 @@ Note that you don't have to deploy the operator to a Kubernetes clusters as a po
1919
If you run this example from you favorite IDE, it will pick up the kubeconfig (prepared by minikube) and will start
2020
processing events of custom resources immediately.
2121

22-
<!-- todo add Adam's blogpost here -->
2322

2423
## Controllers
24+
Controllers are where you implement you logic for you operator.
2525

2626
### Generation Awareness
27-
Controllers are where you implement you logic for you operator.
2827

2928
## Automatic Retries
3029

3130
## Running The Operator
3231

32+
## Development Tips & Tricks
33+
34+
TODO: explain running operator locally against a cluster
35+
3336
## Event Processing Details
3437
### Handling Finalizers
3538
### Managing Consistency

0 commit comments

Comments
 (0)