Fix HTML comment causing ordered list numbering reset

Fixed Vale linter disable comment that was interrupting the ordered list
in the "Event handling" section of watchoperation.md. Moved the Vale
disable comments to wrap around the entire list instead of interrupting
it, which resolves the ordering numbering reset issue.

Signed-off-by: Nic Cope <nicc@rk0n.org>
This commit is contained in:
Nic Cope 2025-08-07 20:54:26 -07:00
parent 1460b62634
commit e604ae5399
2 changed files with 12 additions and 8 deletions

View File

@ -408,10 +408,15 @@ Operations emit Kubernetes events for important activities:
### Troubleshooting operations ### Troubleshooting operations
**Select operation status:** **Check operation status:**
```shell ```shell
kubectl get operation my-operation -o wide kubectl get operation my-operation -o wide
```
**View detailed information:**
```shell
kubectl describe operation my-operation kubectl describe operation my-operation
``` ```

View File

@ -115,13 +115,12 @@ spec:
## Resource injection ## Resource injection
When a WatchOperation creates an Operation, it automatically injects the
changed
<!-- vale write-good.TooWordy = NO --> <!-- vale write-good.TooWordy = NO -->
resource using the special requirement name When a WatchOperation creates an Operation, it automatically injects the changed
`ops.crossplane.io/watched-resource`. resource using the special requirement name
`ops.crossplane.io/watched-resource`. Functions can access this resource without
explicitly requesting it.
<!-- vale write-good.TooWordy = YES --> <!-- vale write-good.TooWordy = YES -->
Functions can access this resource without explicitly requesting it.
For example, when a ConfigMap with label `validate: "true"` changes, the For example, when a ConfigMap with label `validate: "true"` changes, the
WatchOperation creates an Operation like this: WatchOperation creates an Operation like this:
@ -498,10 +497,10 @@ kubectl get events --field-selector involvedObject.name=my-watchop
### Event handling ### Event handling
<!-- vale write-good.TooWordy = NO -->
1. **Implement event filtering** - Check generation, deletion timestamp, 1. **Implement event filtering** - Check generation, deletion timestamp,
and status conditions and status conditions
to avoid processing irrelevant changes to avoid processing irrelevant changes
<!-- vale write-good.TooWordy = NO -->
1. **Monitor operation volume** - Popular resources can create numerous 1. **Monitor operation volume** - Popular resources can create numerous
Operations Operations
<!-- vale write-good.TooWordy = YES --> <!-- vale write-good.TooWordy = YES -->
@ -597,4 +596,4 @@ operational considerations, see [Operation best practices]({{<ref "operation#bes
- Learn about [Operation]({{<ref "operation">}}) for one-time operational tasks - Learn about [Operation]({{<ref "operation">}}) for one-time operational tasks
- Learn about [CronOperation]({{<ref "cronoperation">}}) for scheduled operations - Learn about [CronOperation]({{<ref "cronoperation">}}) for scheduled operations
- [Get started with Operations]({{<ref "../get-started/get-started-with-operations">}}) to create your first reactive operation - [Get started with Operations]({{<ref "../get-started/get-started-with-operations">}}) to create your first reactive operation