Commit Graph

6 Commits

Author SHA1 Message Date
Nic Cope dc1c242c5f Tweak page descriptions
* Keep them concise (~50 chars) for rendering on index pages
* Adjust them for clarity and accuracy
* Add descriptions to pages that were missing them

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 12:18:28 -07:00
Nic Cope 2a39bc9cba
Double check all MR examples (#966)
* Drop note about (only) AWS MRs supporting v2

A few of the other providers like GCP and Azure now do. The rest will
fast follow.

Also, it's not misleading to say the others don't support v2. That reads
like they're incompatible, which they're not. They're just not
namespaced yet.

Signed-off-by: Nic Cope <nicc@rk0n.org>

* Only use modern namespaced provider-upjet-aws MRs

* Make sure they're using v2.0.0 providers
* Make sure they use m.example.org style API groups
* Make sure they're namespaced

Signed-off-by: Nic Cope <nicc@rk0n.org>

---------

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-13 09:56:45 +02:00
Nic Cope d4d3429c7a Use 'Watch Operations' not 'WatchOperation' in sidebar title
Same for CronOperation. This matches the established pattern.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-08 23:00:45 -07:00
Nic Cope e604ae5399 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>
2025-08-07 21:27:54 -07:00
Nic Cope ea1ab2506f Document requirement stabilization pattern for dynamic resource discovery
Add critical guidance for WatchOperation functions that request resources
dynamically. Functions must return consistent requirements across iterations
for proper stabilization. Include working example with error handling.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 4c36f9049c First pass at Operations docs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00