Skip to content

Commit b7a4292

Browse files
authored
website: docs: add oxford comma + simplify example (#6452)
* website: docs: add oxford comma In this case, an oxford comma removes ambiguity. Signed-off-by: Frank Villaro-Dixon <[email protected]> * website: docs: tutorial: simplify example The `RequeueAfter` example looks complicated (no mention of `nextRun`), so add a simple `time.Minute` expression instead. Signed-off-by: Frank Villaro-Dixon <[email protected]> --------- Signed-off-by: Frank Villaro-Dixon <[email protected]>
1 parent feeea7e commit b7a4292

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

website/content/en/docs/best-practices/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Considerations for Operator developers:
1111

1212
- An Operator should manage a single type of application, essentially following the UNIX principle: do one thing and do it well.
1313

14-
- If an application consists of multiple tiers or components, multiple Operators should be written one for each of them. For example, if the application consists of Redis, AMQ and MySQL, there should be 3 Operators, not one.
14+
- If an application consists of multiple tiers or components, multiple Operators should be written one for each of them. For example, if the application consists of Redis, AMQ, and MySQL, there should be 3 Operators, not one.
1515

1616
- If there is significant orchestration and sequencing involved, an Operator should be written that represents the entire stack, in turn delegating to other Operators for orchestrating their part of it.
1717

website/content/en/docs/building-operators/golang/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ The following are a few possible return options for a Reconciler:
293293
```
294294
- Reconcile again after X time:
295295
```go
296-
return ctrl.Result{RequeueAfter: nextRun.Sub(r.Now())}, nil
296+
return ctrl.Result{RequeueAfter: 5 * time.Minute}, nil
297297
```
298298

299299
For more details, check the Reconcile and its [Reconcile godoc][reconcile-godoc].

0 commit comments

Comments
 (0)