Skip to content
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

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Conversation

ezgidemirel
Copy link
Member

@ezgidemirel ezgidemirel commented Jul 4, 2024

Description and context provided in #792 (review)

@ezgidemirel ezgidemirel requested a review from jbw976 July 4, 2024 11:30
Copy link

netlify bot commented Jul 4, 2024

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit 2412953
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/66d586dad41d420008b59757
😎 Deploy Preview https://deploy-preview-792--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 82 (🔴 down 3 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 93 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@negz
Copy link
Member

negz commented Aug 23, 2024

@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.

Copy link
Member

@jbw976 jbw976 left a 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.

@ezgidemirel ezgidemirel force-pushed the fix-comp-rev branch 2 times, most recently from 1e689ba to 8eec2b1 Compare August 29, 2024 11:48
@ezgidemirel
Copy link
Member Author

@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.

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 CompositionRevisions, revision:1 etc..

Copy link
Member

@jbw976 jbw976 left a 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]>
@ezgidemirel
Copy link
Member Author

@jbw976, I've rebased my PR :)

Copy link
Member

@jbw976 jbw976 left a 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! 🙇‍♂️

@jbw976 jbw976 merged commit 1b48f47 into crossplane:master Sep 6, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants