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

Update docs to point to providers sourced from xpkg.crossplane.io. Remove terminology related to Upbound Marketplace #880

Merged
merged 5 commits into from
Feb 25, 2025

Conversation

cwilhit
Copy link
Contributor

@cwilhit cwilhit commented Feb 21, 2025

This change does two things:

  1. It updates all provider usage to refer to only providers published in upstream community in crossplane-contrib.
  2. It removes terminology related to the Upbound Marketplace, since that's a vendor-backed property.

Both of these are done to align with the proposed policy changes in crossplane/crossplane#6290

Copy link

netlify bot commented Feb 21, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit e470506
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/67bdc8a58d12a10008a759e9
😎 Deploy Preview https://deploy-preview-880--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: 84 (🟢 up 22 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (no change from production)
SEO: 100 (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.

@cwilhit cwilhit force-pushed the provider-docs-update branch from 63180b0 to e2c9628 Compare February 21, 2025 13:02
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.

This is great @cwilhit, thanks for driving these changes in the docs, really appreciate it! Feel free to sync directly with me if that's higher bandwidth to get aligned on any of this feedback 🙇‍♂️

…move terminology related to Upbound Marketplace

Signed-off-by: Craig D Wilhite <[email protected]>
Signed-off-by: Craig D Wilhite <[email protected]>
spec:
package: xpkg.upbound.io/upbound/platform-ref-aws@sha256:a30ad655c7699218d9234285d838d85582f015d02f7f061f8486b28248fd7db7
package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart@sha256:a30ad655c7699218d9234285d838d85582f015d02f7f061f8486b28248fd7db7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this configuration package still needs to be pushed, I don't see anything at https://github.com/orgs/crossplane-contrib/packages?repo_name=configuration-quickstart yet

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i also bet this digest won't be the same anymore either, so try to update it to whatever the digest is for the v0.1.0 package that gets published soon. i think this comment applies to previous versions of the docs also.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cwilhit, it's published now! https://github.com/crossplane-contrib/configuration-quickstart/pkgs/container/configuration-quickstart

❯ k get pkg
NAME                                                                          INSTALLED   HEALTHY   PACKAGE                                                                 AGE
configuration.pkg.crossplane.io/crossplane-contrib-configuration-quickstart   True        True      xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0   81s

I think the digest is:

xpkg.crossplane.io/crossplane-contrib/configuration-quickstart@sha256:ef9795d146190637351a5c5848e0bab5e0c190fec7780f6c426fbffa0cb68358

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Updating docs now...

For example, in v1.15.0 Crossplane changed the default image registry from
`index.docker.io` to `xpkg.upbound.io`. Upgrading Crossplane from a version
For example, in v1.20.0 Crossplane changed the default image registry from
`index.docker.io` to `xpkg.crossplane.io`. Upgrading Crossplane from a version
before v1.15.0 updates the default package registry.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update this to v1.20.0 also?

@jbw976
Copy link
Member

jbw976 commented Feb 24, 2025

Looks like 59 new Vale errors to clean up too 😅 - after #810, we're keeping Vale errors completely clean. Warnings are OK, but errors should be fixed.
https://github.com/crossplane/docs/actions/runs/13505935760/job/37741366518?pr=880

That #810 PR should have some hints on how to ignore words that are spelled correctly. Let me know if you need any help! 🙇‍♂️

@jbw976
Copy link
Member

jbw976 commented Feb 25, 2025

Thanks again for driving this @cwilhit, really appreciate your efforts here! 🤩

@jbw976 jbw976 merged commit 5e9d91f into crossplane:master Feb 25, 2025
5 of 6 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