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

Rewrite Concepts root page #666

Merged
merged 4 commits into from
Feb 15, 2024
Merged

Rewrite Concepts root page #666

merged 4 commits into from
Feb 15, 2024

Conversation

plumbis
Copy link
Collaborator

@plumbis plumbis commented Dec 29, 2023

This rewrites the /concepts root page to add new top-level components (Composition functions, Usages) and to pass vale.

This update also slims down the descriptions of each component to not create too much duplication for what's detailed inside each individual component.

Resolves #617 (Boston represent)

@plumbis plumbis requested a review from jbw976 December 29, 2023 20:39
Copy link

netlify bot commented Dec 29, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit c353cf9
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/65ce7083b2cc710008c7885c
😎 Deploy Preview https://deploy-preview-666--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: 90 (🟢 up 2 from production)
Accessibility: 88 (🔴 down 3 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.

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.

Looks pretty good @plumbis, I tested all the links too. Just a few nits for you to consider and decide if/how you'd like to incorporate ✅

[composition documentation]: {{<ref "./compositions" >}}
Crossplane extends Kubernetes allowing Kubernetes to create and manage
resources external to Kubernetes. Crossplane enables platform engineers to
create custom APIs and abstractions combining both native Kubernetes
Copy link
Member

Choose a reason for hiding this comment

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

i've felt like a lot of folks don't get what the point of custom APIs/abstractions if you don't make it clear, e.g. so their developers can get self-service provisioning of the infra they need. Is there a way to work that in?

custom API Crossplane creates a single Composite Resource and links all
the related managed resources to it.

* [**Claims**]({{<ref "./claims">}}) are like Composite Resources, but exist
Copy link
Member

Choose a reason for hiding this comment

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

mention that the point of this is for developer/team access?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added

Composite Resource.

* [**Patches and Transforms**]({{<ref "./patch-and-transform">}}) allow platform
engineers to change user inputs to their custom API and affect how Crossplane
Copy link
Member

Choose a reason for hiding this comment

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

instead of change, would accept work better here?

@phisco
Copy link
Collaborator

phisco commented Feb 14, 2024

@plumbis do we want to get this in for 1.15?

@plumbis
Copy link
Collaborator Author

plumbis commented Feb 15, 2024

Added in JBW's feedback and copied the updated content to v1.15

@plumbis plumbis merged commit 865aa30 into crossplane:master Feb 15, 2024
6 of 7 checks passed
@plumbis plumbis deleted the overview-617 branch February 15, 2024 20:14
@plumbis plumbis mentioned this pull request Feb 15, 2024
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.

Expand Concepts root page with new concepts
3 participants