68a8cd9122
Merge pull request #597 from negz/get-func-ey
...
Add a guide to writing a composition function in Go
2023-11-01 10:49:56 -07:00
de1ed38478
s/seperated/separated ( #602 )
2023-11-01 13:49:27 -04:00
4a77de5f8e
Create CLI docs in Master ( #601 )
2023-11-01 13:49:04 -04:00
5cda5e3e2a
Link to latest docs
...
This seems like the most future-proof option for this guide, which lives
outside of any version.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:48:32 -07:00
acf6be56d4
Fix sneaky Vale spelling errors
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
06d7247c8b
Remove extraneous period.
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
2d3082f7d1
Add MORE BRACES to packages documentation link
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
47e6e77a9c
Clarify that not all functions should delete the input directory
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
fde689dd71
Don't perma-disable the future tense linter
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
038ad6b0f9
Attempt to workaround various "spelling mistakes"
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
6487b23a4f
Update all links to point to master, not latest
...
I do actually want latest, but HTML test complains when I try. There's
no v1.14 release directory to link to yet, so master will have to do.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
a1542b2f4e
Link to go.dev
...
To workaround spellchecker thinking "Go." (with period) is a spelling
mistake.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
698306fb01
Add multi-platform as allowed jargon
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
2343b678ac
Link to Docker docs on multi-platform images
...
We don't have any docs specific to multi-platform _packages_ AFAIK.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
056c350921
Avoid saying "Crossplane CLI's"
...
Vale considers it a spelling mistake, and it's easy to rephrase around.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
9f110571fa
It's function-xbuckets plural, not xbucket
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
0ccf6f0fb5
Add a guide to writing a composition function in Go
...
This is separate from the functions documentation under concepts
because:
1. I expect to have similar guides for other languages, such as Python.
2. The guide will evolve outside of the Crossplane release cycle.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-11-01 10:22:09 -07:00
6c39b914dd
Link to CLI docs from functions docs ( #599 )
2023-11-01 13:19:42 -04:00
5dcc5b814a
V1.14 release ( #596 )
...
Co-authored-by: Philippe Scorsolini <p.scorsolini@gmail.com>
Co-authored-by: Nic Cope <nicc@rk0n.org>
Co-authored-by: Hasan Turken <turkenh@gmail.com>
2023-11-01 10:47:28 -04:00
c819ac2ce3
Merge pull request #570 from turkenh/package-runtime-config
...
Document Deployment Runtime Config
2023-10-31 22:30:16 +03:00
2f7e4fe451
Resolve comments for DeploymentRuntimeConfig
...
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-10-31 22:28:16 +03:00
822d06e6a4
Fix vale errors for provider runtime config
...
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-10-31 22:18:03 +03:00
bddae699c5
Add documentation for DeploymentRuntimeConfig
...
Signed-off-by: Hasan Turken <turkenh@gmail.com>
2023-10-31 22:17:14 +03:00
c0fd459f16
Rewrite packages content and split into Config and Provider chapters ( #566 )
2023-10-31 11:20:46 -04:00
cc67ebd12e
Merge pull request #594 from negz/functional-backup
...
Update Composition Functions content to v1beta1
2023-10-30 16:37:58 -07:00
6524c679d8
Make Go link to go.dev
...
Honestly mostly to workaround Vale thinking "Go." is a spelling mistake.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:49:03 -07:00
6de0d718a5
Add end-to-end to Crossplane dictionary
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:45:14 -07:00
be78d9369c
Style Mermaid diagrams to match light/dark mode
...
This could look better but it's a good start to make the diagrams match the light/dark theme.
There is a bug in here that switching themes doesn't update the diagram (but it works on future loads)
Signed-off-by: Nic Cope <nicc@rk0n.org>
Co-authored-by: Pete Lumbis <pete@upbound.io>
2023-10-30 13:45:14 -07:00
f427bb1bce
Copy edits from composition functions code review
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
Co-authored-by: Pete Lumbis <pete@upbound.io>
2023-10-30 13:45:14 -07:00
a32fbb7b05
Link to section on disabling beta functions
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:45:14 -07:00
6ad29d18ed
Remove reference to xfn Helm values
...
They no longer exist in v1.14
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:12:52 -07:00
c73dc6f7d0
Fix SSA link
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-30 13:02:09 -07:00
7ff74de641
Elaborate on testing functions
...
In particular, elaborate on how to test a function that is under
development.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-28 15:28:41 -07:00
1d1e21a52d
Link to common functions
...
We might want to update these to marketplace links once they're
available.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-28 14:12:43 -07:00
023893b78d
Allow composition function jargon
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:34:38 -07:00
8c7231eb73
Add developer-focused documentation for functions
...
This consists of two sections in the existing page:
* How to write a function
* How functions work
The former is somewhat light, because I intend to add detailed guides
for each language we support. It's hard to go too deep in this general
documentation without using language-specific examples.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:30:21 -07:00
cb1f9d2f9c
Add support for Mermaid diagrams
...
Per instructions from Hugo:
https://gohugo.io/content-management/diagrams/#mermaid-diagrams
The styling could probably be updated to be more in line with the rest
of the docs, but this already looks better to me than the goat ASCII
diagrams Hugo supports out of the box.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:23:12 -07:00
2e993500cb
Document how to use composition functions
...
I plan to use the same page to document how to write a composition
function. I'll add that documenation in a future commit.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:23:12 -07:00
de4d754b4e
Use mostly lowercase f for functions
...
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:23:12 -07:00
9179d8c030
Update Composition Functions content to v1beta1
...
This updates all current documentation of Composition Functions in the
master directory to reflect the new v1beta1 implementation.
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:23:12 -07:00
2370e5bbc1
Update providers to not say they install CRDs ( #590 )
2023-10-27 15:45:21 -04:00
7b041e4678
Document realtime compositions ( #589 )
2023-10-27 13:37:25 -04:00
80a66e8603
fix links for moved platform ref files ( #577 )
2023-10-23 11:42:01 -04:00
7eca790795
Sync Helm chart values table from crossplane/crossplane repo ( #572 )
2023-10-20 13:42:23 -04:00
ef0c5003b8
add support for matching pages when the page title changes ( #567 )
2023-10-18 13:26:50 -04:00
ec54935d1b
Remove trailing underscore from Composition note ( #561 )
2023-10-18 17:19:22 +00:00
fc1a4142da
Fix example configuration that uses an unsupported managementPolicy ( #569 )
2023-10-16 10:23:05 -04:00
bb2042b33b
Fix typos in composition functions documentation ( #560 )
2023-10-06 09:33:33 -04:00
93d85b5d9a
GMP promote to beta ( #563 )
2023-10-04 11:03:50 -04:00
9637e10f54
docs: renaming kubectl plugin to crossplane CLI ( #562 )
2023-10-04 11:00:20 -04:00
Nic Cope
Pete Lumbis
Hasan Turken
Dr. Stefan Schimanski
Jared Watts
Jean du Plessis
Cem Mergenci
Lovro Sviben
Philippe Scorsolini