-
Notifications
You must be signed in to change notification settings - Fork 109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix compositionrevision docs #792
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@ezgidemirel Can you add some context around what this is fixing in the description please? Some of the new changes are failing the Vale grammar linter (see the Checks tab). I suspect not all the warnings were actually introduced by this PR, but it may be worth trying to address some. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe the context for this PR was to restore lost content about CompositionRevisions
, as first noticed in crossplane/crossplane#2882 (comment). After some investigation, it looks like previous edits to add this same content in the past had been lost awhile back due to challenges associated with the branching/releasing strategies used in this repo 🪦
From that investigation, we also determined that this was the only affected and still current content that would need to be restored.
Does this need to be updated for the functions first docs approach in https://github.com/crossplane/docs/pull/799/files#diff-2008ef6855bc5d20d1ee7f4cba4f5e7934943c65bf56f3cdb8de4717bd02eb67? I think it does not need to be.
@ezgidemirel if you could address any vale errors for new content here, that would be great! I wouldn't bother addressing any errors for stuff you're not changing.
1e689ba
to
8eec2b1
Compare
As Jared mentioned, these changes were reverted accidentally some time ago. I've fixed some of the vale errors. The remaining ones are spelling checks for words like |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
d'oh, now that we've released v1.17 @ezgidemirel, would you mind updating this PR to also update v1.17 content and no longer update v1.14 content? 😇
Signed-off-by: ezgidemirel <[email protected]>
8eec2b1
to
2412953
Compare
@jbw976, I've rebased my PR :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for seeing this through @ezgidemirel! 🙇♂️
Description and context provided in #792 (review)