Commit Graph

25 Commits

Author SHA1 Message Date
Nic Cope 331c389ce9 Fix all Vale errors
Not addressing warnings and suggestions though.

These should've all been spelling mistakes and repeated words.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-08-05 21:45:43 -07:00
Nic Cope 80f9dbd72c Move manual RBAC documentation to compositions page
Add refs from other pages where it might come up.

I also added a bit of detail and rephrased to address some Vale linter
warnings.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-04-11 13:47:38 -07:00
Nic Cope 0fd5e1b38e Fix link to function-python
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-31 12:17:01 -07:00
Nic Cope 7f70c27670 Rework "Confused about Compositions..." box
I think we can achieve the goal without explicitly saying this confuses
people. Also reorder so that it starts with what an XR is (the goal)
then talks about how to achieve the goal (XRDs, Compositions).

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-31 12:13:35 -07:00
Nic Cope 1f5283dfa4 Fix broken hash-suffix links
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:50:45 -07:00
Nic Cope 8dd741a208 Replace ancient diagram with mermaidjs
RIP last mention of claims (hopefully).

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:46:51 -07:00
Nic Cope 1ad436082b Composite resource labels go on composed resources, not composites
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:29:49 -07:00
Nic Cope d167c518ca Document XR status conditions
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:29:09 -07:00
Nic Cope 66ca410298 Remove more traces of xmydatabase
No more claims means no more x prefix!

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:25:45 -07:00
Nic Cope 1f375236ca Don't say composition is for managed resources
It's for all resources now!

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:22:28 -07:00
Nic Cope b54dc8b0e6 Change order of composition concepts in side bar
Start with XRs

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:17:20 -07:00
Nic Cope 74e8dedd7e Don't explain how to install Crossplane in comprevs docs
We have a page for that. It's assumed it's installed everywhere else.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:11:11 -07:00
Nic Cope 1d4e24dc76 Drop docs on naming resources with external name annotation
It's an MR feature, not a composition feature. It's documented in the MR
docs.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:09:12 -07:00
Nic Cope 36999a7b34 Use spec.crossplane in all examples
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:08:38 -07:00
Nic Cope 2b766dca93 Use namespaced XRs in examples
Also don't use xMyDatabase as a kind - it's not a valid kind...

Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 23:00:09 -07:00
Nic Cope 32ce91f979 Use new m MR apiVersion in examples
Signed-off-by: Nic Cope <nicc@rk0n.org>
2025-03-28 22:55:57 -07:00
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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