Commit Graph

15 Commits

Author SHA1 Message Date
Nic Cope c005bb353b Address vale warnings and errors
These weren't introduced by this PR - I think they were missed in recent
ones.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 12:32:28 -07:00
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 789826fc13 Auto-generate child page indexes
This way when folks browse to the index pages they'll see an
auto-generated list of child pages.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 11:36:19 -07:00
Nic Cope d71867d6fc
A few low-hanging fruit docs fixes (#971)
* Realtime compositions are beta now

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

* Composition functions don't run on delete

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

* You can't patch XR metadata

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

* Document function response cache

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

---------

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-14 10:10:40 +02: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 1460b62634 Fix status field capitalization to match YAML
Updated status field names in operation.md to match actual YAML
capitalization: conditions, failures, pipeline, appliedResourceRefs
instead of the capitalized versions.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope fcba82541c Add troubleshooting item about --enable-operations flag
Added a new troubleshooting item to operation.md documenting the common
error when Operations feature is not enabled and how to resolve it by
adding the --enable-operations flag to Crossplane's startup arguments.

Updated numbering for subsequent troubleshooting items accordingly.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 5f729d95a7 Fix consistent code blocks in status field list
Add backticks to all status field names (Conditions, Succeeded,
ValidPipeline, Failures, Pipeline) to match AppliedResourceRefs
per Jared's feedback in PR #956.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 02df3dacb7 Fix alphaVersion rendering issue in operations/_index.md
Change alphaVersion from 'v2.0-preview' to '2.0' to avoid
double 'v' rendering in the documentation.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-07 21:27:54 -07:00
Nic Cope 7240b42d83 Fix code block rendering for cron syntax diagram
Change from plain code block to console with disabled line numbers and copy
functionality per docs engineer feedback. Improves visual presentation of the
cron schedule diagram.

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 91edda5d3f Document crossplane alpha render op command
Add Test an operation section to Operations concept documentation showing how to
preview Operations locally using the CLI. Follows same pattern as composition
render documentation with usage examples and output format.

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