crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,476 Commits 4 Branches 9 Tags 40 MiB
Commit Graph

49 Commits

Author SHA1 Message Date
Nic Cope 87516d51ee Style and copy feedback from review 
Review was of the Python guide, but I've applied everything that was
also applicable to the Go guide.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 15:04:06 -08:00
Nic Cope 42f17d9650 Omit FunctionRunner class in introductory Python examples 
In reality you need this, but I don't think we need to introduce it
straight away. In the Go example we already omit the equivalent.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 13:57:35 -08:00
Nic Cope 69f641f894 Copy only the hatch run test:unit command 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 13:57:35 -08:00
Nic Cope 0ad311e0bb Prefer writing 'Protocol Buffers' over protobuf 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 13:57:35 -08:00
Nic Cope f2b684c0bd Add a guide to writing a composition function in Python 
The end result should be the same function as the Go guide, but Python!

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 13:57:35 -08:00
Nic Cope 67a60a857a Small content and format tweaks to Go functions guide 
Several tiny things I noticed while writing the Python guide that I
wanted to apply to the Go guide as well.

Signed-off-by: Nic Cope <nicc@rk0n.org>
 2024-01-12 13:57:35 -08:00
Yury Tsarev f45ad5e9ac
Fix 404 for 'testing composition functions' (#646) 2023-12-03 08:11:37 +02:00
Christopher Haar 151693ec23
fix(examples): fix import examples (#625) 2023-11-27 11:49:02 -05:00
Nic Cope 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
Nic Cope acf6be56d4 Fix sneaky Vale spelling errors 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 06d7247c8b Remove extraneous period. 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 2d3082f7d1 Add MORE BRACES to packages documentation link 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 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
Nic Cope 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
Nic Cope 038ad6b0f9 Attempt to workaround various "spelling mistakes" 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 9f110571fa It's function-xbuckets plural, not xbucket 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-11-01 10:22:09 -07:00
Nic Cope 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
Pete Lumbis c0fd459f16
Rewrite packages content and split into Config and Provider chapters (#566) 2023-10-31 11:20:46 -04:00
Lovro Sviben 93d85b5d9a
GMP promote to beta (#563) 2023-10-04 11:03:50 -04:00
Philippe Scorsolini 9637e10f54
docs: renaming kubectl plugin to crossplane CLI (#562) 2023-10-04 11:00:20 -04:00
Joakim Recht a1478bb2ae
Update composition revisions doc to remove alpha notice (#546) 2023-09-06 16:33:52 -04:00
Pete Lumbis 8dd30fabe3
correct use of helm --set (#535) 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-08-21 07:03:57 -04:00
Lovro Sviben 7ac4dc6c82
update management policies with GMP changes (#510) 
Co-authored-by: Hasan Turken <turkenh@gmail.com>
 2023-08-07 13:02:22 -04:00
Pete Lumbis a06e491011 Update links that pointed to old v1.10 docs 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-07-27 11:04:13 -04:00
Pete Lumbis b67ce1612c
Update for vale checks 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-07-26 21:19:50 -04:00
Pete Lumbis 2583a00224
Update Composition Docs (#475) 2023-07-26 14:26:23 -04:00
Pete Lumbis ca18d5860b
Fix broken external links (#489) 2023-07-18 15:35:08 -04:00
Jared Watts 9044a051ee
Fix Vale errors in release cycle docs and warnings in new release dates section 
Signed-off-by: Jared Watts <jbw976@gmail.com>
 2023-07-05 12:33:02 +02:00
Jared Watts 30715e2518
Clarify that release dates are approximate 
Signed-off-by: Jared Watts <jbw976@gmail.com>
 2023-07-05 12:09:44 +02:00
Pete Lumbis d05ad1aa17
Update MR Section (#457) 2023-06-29 12:02:11 -04:00
Predrag Knezevic 9a13870834 Apply suggestions from code review 
Co-authored-by: Jean du Plessis <jean@upbound.io>
Signed-off-by: Predrag Knezevic <predrag.knezevic@upbound.io>
 2023-06-13 11:52:23 +02:00
Predrag Knezevic 26f8ec3008 More details on possible usage of connection details inside composition function 
Signed-off-by: Predrag Knezevic <predrag.knezevic@upbound.io>
 2023-06-12 14:53:22 +02:00
Manabu McCloskey 98751f192a
add a section for troubleshooting composition (#430) 
* add troubleshooting composition section

Signed-off-by: Manabu Mccloskey <manabu.mccloskey@gmail.com>

* fix vale errors

Signed-off-by: Manabu Mccloskey <manabu.mccloskey@gmail.com>

---------

Signed-off-by: Manabu Mccloskey <manabu.mccloskey@gmail.com>
 2023-05-03 13:40:57 -04:00
Pete Lumbis efdcbfaf72
Adds a KB page linking to AWS's DR guide (#403) 2023-04-17 20:09:17 -04:00
Pete Lumbis a80242ff8a
Add alpha/beta version information to alerts (#375) 2023-03-01 14:09:33 -05:00
Pete Lumbis 310b53f197
remove outdated reference to service catalog (#373) 2023-03-01 13:03:26 -05:00
Piotr Zaniewski e41915e773
Fixing composition functions installation command 
Signed-off-by: Piotr Zaniewski <piotr@upbound.io>
 2023-02-24 11:15:24 +01:00
Pete Lumbis 607513a60d
Restore comp revision example guide (#367) 2023-02-23 12:46:10 -05:00
Pete Lumbis 5fc58271c1
Fix broken links and enable Github action link checker (#344) 
Resolves https://github.com/crossplane/docs/issues/333
Resolves https://github.com/crossplane/docs/issues/340
 2023-02-10 15:11:29 -05:00
Pete Lumbis 904e864a5c
Adds a $ prompt before the first command in each shell output (#337) 
Resolves https://github.com/crossplane/docs/issues/317
 2023-02-09 17:27:50 -05:00
hasheddan f211b54152
Correct xfn sidercar to container rather than pod 
Updates docs to state that the xfn function runner is deployed as a
sidecar container rather than a pod.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2023-02-08 20:16:30 -05:00
Pete Lumbis 542668be7b
Fix broken image in composite function guide (#312) 2023-02-01 14:42:31 -05:00
Nic Cope 8af5cbaa28 Highlight requirements.txt as Python 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-01-31 16:15:24 -08:00
Nic Cope 7e07837407 Document the alpha Composition Functions feature 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-01-31 16:15:19 -08:00
Pete Lumbis 85407e88c6
Docs Reorg for v1.11 (#271) 
Reorg and new home page for docs.
 2023-01-31 18:59:52 -05:00