Commit Graph

497 Commits

Author SHA1 Message Date
Jared Watts a7187c7479
v2: use XP_CHANNEL=preview for CLI install
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-31 07:51:12 +01:00
Nic Cope 89f1d474b9
Merge pull request #905 from negz/so-fresh
Add "What's new in v2.0?" page
2025-03-28 21:07:57 -07:00
Nic Cope ffe6d2c590 Remove redundant statement about backward compatbility
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:48:18 -07:00
Nic Cope a2a2d3f5b5 Fix grammar errors
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:44:34 -07:00
Nic Cope 2dab2fcaba Add links to backward compatibility heading
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:42:30 -07:00
Nic Cope aac9cda786 Add "What's new in v2.0?" page
This page is targeted at folks who're already familiar with v1.x and
just want to know what's new.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 19:54:13 -07:00
Nic Cope 045bd0b1a5
Merge pull request #903 from jbw976/v2-apis
update CRDs for v2.0-preview
2025-03-28 18:21:44 -07:00
Jared Watts d060988e5b
manually set XRD v2alpha1 as the storage version so it will be displayed in API reference
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 18:05:50 -07:00
Nic Cope 3b37063755
Merge pull request #904 from negz/whats-new
Use a different warning for preview versions
2025-03-28 17:31:50 -07:00
Jared Watts 31c766b48f
update CRDs for v2.0-preview
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 17:29:33 -07:00
Nic Cope 7a4d6a0a83 Use a different warning for preview versions
This'll match any version ending with "-preview" and show a warning that
it's a preview, instead of warning that it's an old version.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 16:51:28 -07:00
Nic Cope d01b615fa7 Return to calling old versions old versions
Revert "Say "not the latest version" instead of "old version""

This reverts commit f7ba7d9ffd.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 16:51:22 -07:00
Nic Cope 104324c0c9 Use same tone/patterns in both getting started guides
This mostly edits the get started with MRs guide to use the same tone
and patterns as the get started with compositions guide.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 16:27:47 -07:00
Nic Cope af26389513 Get started with composition
The goal of this guide is to:

* Introduce composition as a standalone concept (i.e. no MRs needed)
* Showcase a namespaced composition
* Showcase some different composition functions - i.e. different config language options

I'm also taking a different approach to the previous getting started guides, in that
I'm leaving out a lot of explanation of what things are. Instead I'm prioritizing having
folks apply things (even if they don't fully understand them) and seeing the results.
I feel more detailed explanations should come after the get started guides - e.g. in the
concepts section.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 14:22:24 -07:00
Nic Cope 21f08cb050 Use smaller headings
I notice the sidebar doesn't seem to work when the top level headings
are H1 (single # in Markdown). It shows all the headings at the same
level of nesting.

Using H2 and H3 (## and ###) seems to fix it. This is what most other
docs pages seem to do.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 22:28:19 -07:00
Nic Cope 8fb50ebfe5 Say 'App' not 'Application' on What's Crossplane page
I notice Vale recommends App rather than Application.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 22:28:19 -07:00
Jared Watts 3462331316
incorporate PR feedback for get started with managed resources page
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 19:26:17 -07:00
Jared Watts f78a611aaf
Streamline getting started with managed resources guide by removing fine grained details
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 17:12:34 -07:00
Jared Watts 0fd8146ff4
full walkthrough for get started with managed resources guide
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-27 16:37:26 -07:00
Nic Cope 9adb066cf2
Merge pull request #897 from negz/intro
[v2] Add a "What's Crossplane?" page
2025-03-27 14:30:15 -07:00
Nic Cope 1d4a2be614 Rename to "What's Crossplane"
Vale says it's better.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 14:00:49 -07:00
Nic Cope f7b7f3ef46 Minor diagram tweaks
Mostly say 'Composition Engine' rather than 'Crossplane Composition' to
distinguish from the Composition API type.

'Crossplane Composition Engine' won't fit.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 13:58:26 -07:00
Nic Cope db98c82333 Briefly clarify why a function pipeline is better than a controller
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 13:45:47 -07:00
Nic Cope edc2003852 Fix typo - control plane singular
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 12:14:21 -07:00
Nic Cope ec0716b1c9 Link to Crossplane install guide
Don't repeat it.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 23:39:20 -07:00
Nic Cope 19507da134 Use Viktor's video that explains CRs and controllers
I promise I'm not biased, I just happened to search for resources and
found it a lot better than the Kubernetes docs.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 23:03:10 -07:00
Nic Cope 029548b310 Move all introductory info to a "What is Crossplane?" page
I found myself unsure where to introduce Crossplane and its components
on the landing page and getting started pages. A dedicated page seemed
like a better idea.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 22:52:13 -07:00
Nic Cope 549c338f48 Update the get started landing page
This is now where we introduce the three components of Crossplane.

In future we might benefit from a more detailed "what is Crossplane?"
page.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 20:59:05 -07:00
Nic Cope f4b648cd82 Mention that clouds are built with control planes earlier
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 17:25:06 -07:00
Nic Cope b4a722aa4e Talk about configuring software - not deploying it
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 16:28:26 -07:00
Nic Cope 9188eb598a Rework the landing page
This tries to:

* Modernize how we frame Crossplane
* Briefly introduce folks to the docs sections

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 16:05:27 -07:00
Nic Cope 10af7ac2cf Use preview Helm repo in the upgrade docs
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 14:33:31 -07:00
Nic Cope dcac6e0602 Update install guide to install the preview
* Use the preview Helm repo
* Don't discuss the master Helm repo
* Defer to upstream and Helm docs to document Helm and our chart's
  options

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 14:24:20 -07:00
Nic Cope cc358cdbfe
Merge pull request #895 from negz/v2-preview-setup
v2 Preview Docs Restructuring
2025-03-26 13:01:39 -07:00
Nic Cope 85c6313321 Merge "introduction" into the get started landing page
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 12:11:54 -07:00
Nic Cope 659082698e Move install into get started
Move upgrade and uninstall into guides

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 12:09:57 -07:00
Nic Cope b8b91d1a9b Rename Getting Started to Get Started
Sounds more action-ey!

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 11:59:18 -07:00
Nic Cope 7da8d4348f Restructure getting started
We want to focus on two things:

* Get started with Composition
* Get started with Managed Resources

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-26 11:57:48 -07:00
Nic Cope c664ce812a
Merge pull request #892 from twobiers/fix/server-side-apply-beta
Update server-side apply documentation with beta promotion
2025-03-25 22:44:20 -07:00
Nic Cope 592c9bc034 Remove mention of claims from getting-started
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 22:38:02 -07:00
Nic Cope 74ce12d8c7 Remove reference to importing resources
This page was deleted (for now).

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 22:33:50 -07:00
Nic Cope 82f9842e68 Remove links to deleted getting started pages
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 22:33:50 -07:00
Nic Cope b84fd314a1 Drop references to external secret stores and controller configs
Both removed in Crossplane v2

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 22:20:17 -07:00
Nic Cope 94b962123f Remove all references to claims
In some cases I've removed large amounts of content, where we're not
going to have time to rewrite it to avoid mentioning claims - e.g. how
connection secrets work in composition.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 22:09:58 -07:00
Nic Cope 6699f51daf Remove most getting started guides
We only want to keep the getting started guide for AWS MRs.

We won't have GCP or Azure support in time for the preview release.
We're going to add a separate getting started with composition page
that's decoupled from any one provider.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 21:10:05 -07:00
Nic Cope dae6256f4e Remove claims pages from concepts
There'll be more to find in the content of each page, but these entire
pages can be removed. There's no claims in Crossplane v2.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 21:06:49 -07:00
Nic Cope fecf3de3ae Remove outdated or irrelevant guides
These guides are either no longer relevant in Crossplane v2, or would
need too much work to have them ready in time for the preview release.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 21:04:39 -07:00
Nic Cope f7ba7d9ffd Say "not the latest version" instead of "old version"
With the v2.0-preview version we're in a weird spot where v2.0-preview
is newer than latest. So we want the "not latest" warning, but not to
call it old.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-25 19:39:08 -07:00
Nic Cope fd361e5cec Remove the 'v' from v2.0-preview
Looks like _index shouldn't have a leading v. Something else prefixes a
v on the dropdown.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-21 15:38:14 -07:00
Nic Cope 7a1ea65c6b v2.0, not v2.0.0
Docs semvers are only major.minor - no patch.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-21 15:35:55 -07:00