32ce91f979
Use new m MR apiVersion in examples
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:55:57 -07:00
9bfea3f5a5
Remove docs on schema aware composition validation
...
Not relevant to functions. There's still some validation but it's common
sense unconfigrable CEL stuff - not worth documenting.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:54:17 -07:00
9e8148807b
Drop mention of connection details in composition
...
We might remove connection details from XRs in v2. Skip it for now.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:53:25 -07:00
fe1bc63c28
Drop environment config mention in context
...
I don't think this happens by default anymore - we use function env
config
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:50:34 -07:00
055d9a8f8c
Drop references to native P&T
...
It's gone in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:49:48 -07:00
2a9bc76b57
Say "Environment Configs"
...
It makes vale mad but it matches Image Configs in the sidebar
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:43:05 -07:00
ed054981cc
Add a stub page on function packages
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:41:57 -07:00
e4e84575cd
Rename 'Packages' to 'Configurations'
...
The page mostly documents configurations
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:28:40 -07:00
dd0f208f38
Update MRs concepts, and drop all other mentions of connection details
...
We're considering removing connection details from XRs in v2 so for now
focus on their existence at the MR level.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:22:42 -07:00
09cd24221d
Fix a bunch of links to master docs
...
We really should go back to git branches...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:09:22 -07:00
81f61530cf
Update connection details for v2
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:05:48 -07:00
89dbb4427a
Document Usages for v2
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:03:51 -07:00
dc39ca3f50
Break concepts out by component
...
Ideally these would nest under concepts in the side bar but that's not
possible.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:43:47 -07:00
e6822614de
Remove dangling references to claims
...
We don't want folks using them in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:21:29 -07:00
0166c54060
Remove leftover reference to StoreConfigs
...
They're removed in v2
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:16:37 -07:00
3e28b5b768
Move "Crossplane pods" from concepts to guides
...
It's arguably neither but feels more like a guide.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:15:29 -07:00
61c36b6f7d
Remove concepts landing page
...
Most others are empty - maybe we can have them automatically list
subpages?
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 21:08:30 -07:00
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
ffe6d2c590
Remove redundant statement about backward compatbility
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:48:18 -07:00
a2a2d3f5b5
Fix grammar errors
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:44:34 -07:00
2dab2fcaba
Add links to backward compatibility heading
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 20:42:30 -07:00
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
7a596b46dd
Make vale understand more types of version
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 19:54:13 -07:00
045bd0b1a5
Merge pull request #903 from jbw976/v2-apis
...
update CRDs for v2.0-preview
2025-03-28 18:21:44 -07:00
0c56ab2d5c
show (deprecated) for deprecated APIs on API reference
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 18:06:21 -07:00
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
3b37063755
Merge pull request #904 from negz/whats-new
...
Use a different warning for preview versions
2025-03-28 17:31:50 -07:00
31c766b48f
update CRDs for v2.0-preview
...
Signed-off-by: Jared Watts <jbw976@gmail.com>
2025-03-28 17:29:33 -07:00
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
d01b615fa7
Return to calling old versions old versions
...
Revert "Say "not the latest version" instead of "old version""
This reverts commit f7ba7d9ffd
2025-03-28 16:51:22 -07:00
017ee79d92
Merge pull request #901 from negz/get-started-composition
...
[v2] Add a new 'Get Started With Composition' guide
2025-03-28 16:50:59 -07:00
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
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
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
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
6a4cf06ee7
Merge pull request #900 from jbw976/mr-go
...
full walkthrough for get started with managed resources guide
2025-03-27 20:42:54 -07:00
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
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
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
4fcbeb86e1
Merge pull request #899 from negz/the-purge
...
Ignore Mermaid styling when purging CSS
2025-03-27 14:42:44 -07:00
74380e6283
Ignore Mermaid styling when purging CSS
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 14:38:57 -07:00
9adb066cf2
Merge pull request #897 from negz/intro
...
[v2] Add a "What's Crossplane?" page
2025-03-27 14:30:15 -07:00
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
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
45f61d1c59
Fix box and edge colours of mermaid diagrams
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 13:58:21 -07:00
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
edc2003852
Fix typo - control plane singular
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-27 12:14:21 -07:00
ea173ff105
Merge pull request #898 from negz/get-started-mrs
...
[v2] Link to Crossplane install guide
2025-03-27 08:22:31 -07:00
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
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
Jared Watts
Nicholas Thomson