First pass at Operations docs #956
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
negz
force-pushed
the
whats-op-doc
branch
8 times, most recently
from
dabe420 to
78092bc
Compare
2 tasks
negz
commented
Aug 7, 2025
tr0njavolta
approved these changes
Aug 7, 2025
negz
force-pushed
the
whats-op-doc
branch
2 times, most recently
from
8118d1c to
21bed19
Compare
|
Gonna hold on merging until crossplane/crossplane#6695 is merged, since this PR documents stuff in that one (namely |
negz
added a commit
to negz/docs
that referenced
this pull request
Aug 8, 2025
Apply backticks to Kubernetes resource types (Operation, Ingress, ClusterRole, Job) to follow documentation style conventions for API objects per Jared's feedback in PR crossplane#956.
negz
added a commit
to negz/docs
that referenced
this pull request
Aug 8, 2025
Add backticks to all status field names (Conditions, Succeeded, ValidPipeline, Failures, Pipeline) to match AppliedResourceRefs per Jared's feedback in PR crossplane#956.
negz
force-pushed
the
whats-op-doc
branch
2 times, most recently
from
b6a7d66 to
00b3296
Compare
Feels like it belongs here as a top-level tool, despite being alpha. Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
Signed-off-by: Nic Cope <[email protected]>
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 <[email protected]>
…very 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 <[email protected]>
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 <[email protected]>
Change alphaVersion from 'v2.0-preview' to '2.0' to avoid double 'v' rendering in the documentation. Signed-off-by: Nic Cope <[email protected]>
Apply backticks to Kubernetes resource types (Operation, Ingress, ClusterRole, Job) to follow documentation style conventions for API objects per Jared's feedback in PR crossplane#956. Signed-off-by: Nic Cope <[email protected]>
Add backticks to all status field names (Conditions, Succeeded, ValidPipeline, Failures, Pipeline) to match AppliedResourceRefs per Jared's feedback in PR crossplane#956. Signed-off-by: Nic Cope <[email protected]>
Changed 'SSL Monitor Operation API' to 'SSL Monitor Operation' in the mermaid diagram to prevent text truncation that was showing as 'SSL Monitor Operation AP' in the rendered output. Signed-off-by: Nic Cope <[email protected]>
Sorted all dictionary files in utils/vale/styles/Crossplane/ alphabetically: - allowed-jargon.txt - brands.txt - crossplane-words.txt - provider-words.txt - spelling-exceptions.txt This removes duplicate entries and ensures consistent ordering for easier maintenance and Vale linting compliance. Signed-off-by: Nic Cope <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
Added introductory sentence before Operations diagram to match the pattern used for other diagrams. Explains the SSL certificate monitoring scenario that the diagram illustrates, connecting the use case to the visual representation. Signed-off-by: Nic Cope <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First pass at Operations documentation including getting started guide and concept documentation.
I've tested the getting started guide end-to-end in a live cluster and it works perfectly. Here's what I validated:
Test Environment:
--enable-operations)Test Results:
All steps in the getting started guide work as documented:
cert-monitor.crossplane.io/expires: Sep 29 08:34:02 2025 GMTcert-monitor.crossplane.io/days-until-expiry: "53"cert-monitor.crossplane.io/status: okSYNCED=TrueandSUCCEEDED=Truewith detailed outputThe key functionality works correctly: required resource fetching, SSL certificate inspection via Python, resource modification (adding annotations), and operation output for monitoring.
Dependencies
crossplane alpha render opcommand (tested and working)