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

321 Commits

Author SHA1 Message Date
Hasan Turken 822d06e6a4
Fix vale errors for provider runtime config 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:18:03 +03:00
Hasan Turken bddae699c5
Add documentation for DeploymentRuntimeConfig 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-10-31 22:17:14 +03:00
Pete Lumbis c0fd459f16
Rewrite packages content and split into Config and Provider chapters (#566) 2023-10-31 11:20:46 -04:00
Nic Cope 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
Nic Cope 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
Nic Cope a32fbb7b05 Link to section on disabling beta functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:45:14 -07:00
Nic Cope 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
Nic Cope c73dc6f7d0 Fix SSA link 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-30 13:02:09 -07:00
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope 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
Nic Cope de4d754b4e Use mostly lowercase f for functions 
Signed-off-by: Nic Cope <nicc@rk0n.org>
 2023-10-27 19:23:12 -07:00
Nic Cope 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
Pete Lumbis 2370e5bbc1
Update providers to not say they install CRDs (#590) 2023-10-27 15:45:21 -04:00
Dr. Stefan Schimanski 7b041e4678
Document realtime compositions (#589) 2023-10-27 13:37:25 -04:00
Pete Lumbis 80a66e8603
fix links for moved platform ref files (#577) 2023-10-23 11:42:01 -04:00
Jared Watts 7eca790795
Sync Helm chart values table from crossplane/crossplane repo (#572) 2023-10-20 13:42:23 -04:00
Jean du Plessis ec54935d1b
Remove trailing underscore from Composition note (#561) 2023-10-18 17:19:22 +00:00
Cem Mergenci fc1a4142da
Fix example configuration that uses an unsupported managementPolicy (#569) 2023-10-16 10:23:05 -04:00
mergenci bb2042b33b
Fix typos in composition functions documentation (#560) 2023-10-06 09:33:33 -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
Nandor Magyar 883ded5096
Fix typo of Manager in install.md files (#558) 
Signed-off-by: Nandor Magyar <nandormagyar.it@gmail.com>
 2023-09-28 06:04:36 -07:00
James Dobson eaca063993
Fixed formatting of annotation table in managed-resources.md. (#555) 2023-09-21 18:01:49 -04:00
Sharp 441b9fe731
Updates AWS get started composition (#552) 2023-09-19 09:36:51 -04:00
Yonatan Koren 7395c2460b
Composite Resources: fix snippet on `compositionRevisionRef` (#551) 2023-09-19 11:13:46 +03:00
Pete Lumbis 7ec21a91eb
Update guidlines on envConfigs and patching to XRs (#549) 2023-09-18 17:09:56 -04:00
Jean du Plessis daaa7ec019
Updates the ControllerConfig deprecation warning (#548) 2023-09-14 14:14:55 +00:00
Sharp 44f6912a6e
Adds managedPolicies config enablement (#547) 2023-09-11 16:15:37 -04:00
Hasan Turken abf3dc4800
Add notes and tips to Usage 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:45:13 +03:00
Hasan Turken 196e10bd8e
Fix vale errors in usages.md 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:18:59 +03:00
Hasan Turken a06f55dd57
Add documentation for alpha Usages 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-09-11 15:18:59 +03:00
Philippe Scorsolini aaf02bb6ac
Merge pull request #544 from phisco/dev/xp-3723 2023-09-06 09:18:02 +02:00
Philippe Scorsolini 8c9fa333c5
chore: review 
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
 2023-09-05 20:08:12 +02:00
Lucas Caparelli 02c676f6eb
Document MatchTrue, MatchFalse and MatchCondition readiness checks (#513) 
Co-authored-by: Pete Lumbis <pete@upbound.io>
 2023-09-05 11:41:54 -04:00
Philippe Scorsolini f02fd57412
feat: optional environment label selector fieldpath 
Co-authored-by: Pete Lumbis <pete@upbound.io>
Signed-off-by: Philippe Scorsolini <p.scorsolini@gmail.com>
 2023-09-05 17:25:54 +02:00
Pete Lumbis 480b7e9232
Remove included pages from local search and search engines (#542) 2023-09-01 14:36:32 +00:00
Noa Resare 1ddcf18157
Update the link to the aws provider authentication docs (#540) 2023-08-29 14:08:18 -04:00
Hasan Turken 3b58e158b3
Add support for convert from json to object/list 
Signed-off-by: Hasan Turken <turkenh@gmail.com>
 2023-08-29 11:41:08 +03:00
Pete Lumbis 151ab38f09
Update Vale to latest (#534) 2023-08-28 14:31:26 -04:00
Hasan Turken fd41266a1e
Add support for FromJson convert transform (#539) 2023-08-28 13:47:37 -04:00
Hasan Turken e2bc4aded9
Merge pull request #537 from youyongsong/fix/string-format-example 
Fix incorrect string format example in documentation
 2023-08-25 12:06:12 +03:00
yongsong you 29e13f3112 Fix incorrect string format example in documentation 
Signed-off-by: youyongsong <youyongsong@gmail.com>
 2023-08-23 18:17:53 +08: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
Jerod Culpepper ac61c7ee68
Update provider version and fix azure typo (#531) 
Co-authored-by: Jerod Culpepper <jerod.culp.work@gmail.com>
 2023-08-14 08:35:32 -04:00
Steven Borrelli 55b5c1ceb5
add doc for adler32 transform (#524) 2023-08-08 17:37:58 -04:00
Pete Lumbis 4fb5c34478
Update quickstarts to use provider families (#511) 2023-08-08 11:06:24 -04:00
Kenan Alptekin f8107a71a8 fix links in table for patch types 
Signed-off-by: Kenan Alptekin <kenan@alptekin.me>
 2023-08-07 22:07:20 -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 9d6c75cb50
Fix snippets location in github (#519) 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-08-07 12:15:21 -04:00
Jean du Plessis fc346cc528
Merge pull request #512 from plumbis/snippets 2023-08-02 18:30:38 +02:00
Pete Lumbis b144687f87
update links to snippets github folder 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-07-31 21:23:30 -04:00
Amund Tenstad 872d68e35c
docs: clarify content of desired resources in composition functions (#506) 2023-07-28 09:40:44 -04:00
Pete Lumbis c3c830b11f
add links to feature flags and pod flags (#505) 2023-07-27 12:26:44 -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
Christopher Haar a328fbf179
fix(deletionPolicy): fix correct capital (#496) 
Signed-off-by: Christopher Haar <christopher.haar@upbound.io>
 2023-07-22 10:24:43 -04:00
Christopher Haar 4772a24324 fix(docs): fix poll-interval - 
Signed-off-by: Christopher Haar <christopher.haar@upbound.io>
 2023-07-20 16:32:20 +02:00
Jared Watts 450ea44cdc
Clarify the specifics of connection details in compositions (#485) 2023-07-18 17:52:05 -04:00
Pete Lumbis ca18d5860b
Fix broken external links (#489) 2023-07-18 15:35:08 -04:00
Pete Lumbis d05ad1aa17
Update MR Section (#457) 2023-06-29 12:02:11 -04:00
Pete Lumbis 6cf6288d36
Add more details and organize provider Conditions (#458) 2023-06-27 13:23:40 -04:00
Philippe Scorsolini 3028dbc892
docs: suggest using image digests for security reasons (#465) 
Co-authored-by: Philippe Scorsolini <p.scorsolini@gmail.com>
Co-authored-by: AdamKorcz <adam@adalogics.com>
Co-authored-by: Jean du Plessis <jean@upbound.io>
 2023-06-22 12:42:17 -04:00
Pete Lumbis 149635b7f9
Fix copy button to only copy the command and not the output (#474) 2023-06-21 15:46:51 -04:00
Pete Lumbis d9684d2418
Update and expand Azure QuickStarts (#444) 
Co-authored-by: Pete Lumbis <plumbis@users.noreply.github.com>
 2023-06-21 11:50:46 -04:00
Jean du Plessis f013f2af62
Merge pull request #470 from plumbis/edit-370 2023-06-20 17:46:50 +02:00
Pete Lumbis c55707d786
Update usage of editCode marker 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-06-20 11:29:55 -04:00
Manabu Mccloskey 38ec341d4e add an example for claiming existing xr 
Signed-off-by: Manabu Mccloskey <manabu.mccloskey@gmail.com>
 2023-06-12 10:28:30 -06:00
Pete Lumbis d3ebe1f2bf
Update helm chart options for install pages (#459) 
Co-authored-by: Philippe Scorsolini <p.scorsolini@gmail.com>
 2023-06-08 15:31:40 -04:00
Pete Lumbis 75d22ebb8f
New page on crossplane pods (#412) 2023-05-31 16:04:48 -04:00
Pete Lumbis 5ccd9b1b83
Corrects statement about UXP to Up CLI. Resolves #331 (#445) 2023-05-18 13:31:49 -04:00
Pete Lumbis 77a5ec7e71
Updates GCP quickstarts to match v1.11's three-part guide (#446) 2023-05-18 13:31:33 -04:00
Pete Lumbis ada46d6b63
Update k8s version to say 'actively supported' 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-05-09 17:28:14 -04:00
Pete Lumbis 53e59a9037
add information about supported k8s versions (#437) 2023-05-09 16:17:08 -04:00
Pete Lumbis e0d897441c
Fix XRD/CRD mixup (#435) 2023-05-09 15:21:05 -04:00
Mikhail Naletov 01c1182871
feat: fix typo in concepts doc 
Signed-off-by: Mikhail Naletov <okgolove@markeloff.net>
 2023-05-06 20:51:52 +03:00
Pete Lumbis 4f213f50e7
Concepts: Provider rewrite (#420) 2023-05-05 16:50:47 -04:00
Hasan Turken 2fb64eb948
Document Management Policies (#407) 2023-05-02 12:01:09 -04:00
Bob Haddleton 6db0791713
Add documentation for new defaults (#411) 2023-04-20 10:35:26 -04:00
Philippe Scorsolini 15c365270d
docs: document ToJson convert transform option (#406) 
Co-authored-by: Lovro Sviben <sviben.lovro@gmail.com>
 2023-04-18 08:56:59 -04:00
Philippe Scorsolini 7c06450dac
document feature flags available (#402) 
Co-authored-by: Pete Lumbis <plumbis@users.noreply.github.com>
 2023-04-18 08:53:03 -04:00
Philippe Scorsolini d4417ac638
docs: composition validation (#399) 
Co-authored-by: Jean du Plessis <jean@upbound.io>
Co-authored-by: Pete Lumbis <plumbis@users.noreply.github.com>
 2023-04-18 08:31:07 -04:00
Hasan Turken 3b14a9fa2c
Merge pull request #391 from julienduchesne/patch-1 
Math Transforms: Document `ClampMin` and `ClampMax`
 2023-04-11 10:26:03 +03:00
Julien Duchesne 5ae360f904 `input` -> `output` 
Signed-off-by: Julien Duchesne <julien.duchesne@grafana.com>
 2023-04-10 14:32:54 -04:00
Julien Duchesne 11eadf43b4
`match` transform: Document the `fallbackTo` option (#392) 2023-04-10 11:06:41 -04:00
Julien Duchesne cc2d868032 Math Transforms: Document `ClampMin` and `ClampMax` 
Feature added in this PR: https://github.com/crossplane/crossplane/pull/3917

Signed-off-by: Julien Duchesne <julien.duchesne@grafana.com>
 2023-04-09 23:01:18 -04:00
Jean du Plessis e01ce461c1 Add missing and remove duplicate link definitions 
Signed-off-by: Jean du Plessis <jean@upbound.io>
 2023-03-31 17:11:01 +02:00
Jared Watts 3beafc44e4
Update Azure getting started guide to use provider-azure:v0.29.0 
Signed-off-by: Jared Watts <jbw976@gmail.com>
 2023-03-28 13:55:44 -07:00
Jean du Plessis c349ba7f21 Add quotes around annotation value 
Signed-off-by: Jean du Plessis <jean@upbound.io>
 2023-02-19 09:10:42 +02: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
hasheddan 270352b2c6
Remove broken install crossplane embeds in quickstarts 
Removes broken crossplane installation instructions.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2023-02-10 10:48:46 -05:00
hasheddan 83d6acc9df
Fix broken helm link in GCP quickstart 
Fixes a broken helm link in the GCP quickstart.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2023-02-10 10:44:44 -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 80d4c8800d
Add warning that ControllerConfig is deprecated 
Adds a warning in the package documentation that the ControllerConfig
API is now deprecated.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2023-02-07 23:38:26 -05:00
Pete Lumbis 1cf380d64a
corrects link to managed-resources that has incorrect quotes (#320) 2023-02-02 09:47:47 -05:00
Pete Lumbis aed9a2384f
Fixes links that generate bad links due to Hugo limitation (#319) 2023-02-02 09:40:04 -05: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
MisterMX 2deefae089
docs(compositions): Add docs for quantity transform (#292) 
Signed-off-by: Maximilian Blatt <maximilian.blatt-extern@deutschebahn.com>

Signed-off-by: Maximilian Blatt <maximilian.blatt-extern@deutschebahn.com>
 2023-01-23 21:06:23 -05:00
MisterMX 0e8d93f756
docs(transform): Add docs for hash transform (#293) 
Signed-off-by: Maximilian Blatt <maximilian.blatt-extern@deutschebahn.com>

Signed-off-by: Maximilian Blatt <maximilian.blatt-extern@deutschebahn.com>
 2023-01-23 13:46:16 -05:00
hasheddan 0da8b34033
Update v1.10 patch versions to v1.10.2 
Updates all v1.10.1 references to v1.10.2.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2023-01-19 22:49:58 -05:00
Pete Lumbis 23164929f2
move content media to top level folder (#265) 
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
 2023-01-12 21:57:48 -05:00
Crossplane d3fdfab876 docs snapshot for crossplane version `master` 2022-12-28 18:31:25 +00:00
Crossplane 4c35456406 docs snapshot for crossplane version `master` 2022-12-26 09:24:59 +00:00
Crossplane 261400307d docs snapshot for crossplane version `master` 2022-12-19 08:08:19 +00:00
Crossplane 9fd142c5c8 docs snapshot for crossplane version `master` 2022-12-13 04:43:38 +00:00
Crossplane 86993c7912 docs snapshot for crossplane version `master` 2022-12-12 22:23:07 +00:00
Crossplane 225a3a038d docs snapshot for crossplane version `master` 2022-12-08 03:28:18 +00:00
Crossplane bf9aeb13d9 docs snapshot for crossplane version `master` 2022-12-05 23:44:26 +00:00
hasheddan ea3dcbc4a0
Drop symlink to master directory 
Drops symlink to master directory so that the directory itself can be
re-inserted on next merge.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
 2022-12-05 17:45:52 -05:00
Crossplane 87253feb22 docs snapshot for crossplane version `master` 2022-12-05 20:50:18 +00:00
Crossplane a469573353 docs snapshot for crossplane version `master` 2022-12-03 14:34:28 +00:00
Crossplane 0006408e86 docs snapshot for crossplane version `master` 2022-12-02 15:32:13 +00:00
Crossplane 998119a9d6 docs snapshot for crossplane version `master` 2022-12-02 13:17:50 +00:00
Crossplane 90db6ed8f6 docs snapshot for crossplane version `master` 2022-12-01 22:07:34 +00:00
Crossplane dd68f7e9dc docs snapshot for crossplane version `master` 2022-12-01 17:18:34 +00:00
Pete Lumbis f1e0f4d865
Docs redesign (#210) 
This completely redesigns the docs and moves them to a new domain docs.crossplane.io and hosting on Netlify. 

This creates a custom Hugo theme affectionally called `Geekboot` based the work of both [Geekdoc](https://geekdocs.de/) and [Bootstrap](https://github.com/twbs/bootstrap/tree/main/site).

[Lighthouse testing on desktop](https://pagespeed.web.dev/report?url=https%3A%2F%2Fdocs.crossplane.io%2Fv1.10%2F&form_factor=desktop) gives the site a 100/100 in performance and best practices, 90/100 in accessibility and 92/100 in SEO.

Besides new layout and colors other new user-facing features include:
* Dark mode
* Fully responsive design and mobile ready
* Automated webp image conversion and optimization as well as lazy loading
* Tabs 
* Alerts and hint boxes
* Foldable/hide long outputs
* Linkable anchors inside tabs
* Improved code boxes with line numbers 
* Adds support for docs.crossplane.io/latest
* Right hand page table of contents 
* Improved text readability 

Infrastructure improves:
* Uses [Bootstrap](https://getbootstrap.com/) to dramatically simplify styling and site development 
* Prefetch links on hover using [instant.page](https://instant.page/)
* Highly optimized CSS using PostCSS and [PurgeCSS ](https://purgecss.com/) without requiring users to install additional tools
* Minimizes the use of JavaScript and bundles scripts with [Webpack](https://webpack.js.org/) to optimize load times
* Massive improvement of SCSS/CSS organization and overrides improving the development process for stylesheet changes
* Optimizes existing SVGs and converts all other template images to webp
* Minification on production builds to further reduce page sizes

This also bumps the `Makefile` Hugo version to [0.107.0](https://github.com/gohugoio/hugo/releases/tag/v0.107.0) to pick up build improvements related to code syntax highlighting, improving builds about about 20-30% in unscientific testing.
 2022-12-01 11:11:29 -05:00
Pete Lumbis f81ae95e57
move docs content to /docs. Update left nav menu and dropdown menu for new layout 
Signed-off-by: Pete Lumbis <plumbis@users.noreply.github.com>
 2022-10-07 17:43:56 -04:00
Pete Lumbis fdf7203acb
Merge github.com:crossplane/crossplane.github.io 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2022-10-05 11:57:09 -04:00
Pete Lumbis c01409f9f0
add instructions to contribute to crossplane.io 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2022-10-05 11:10:07 -04:00
Pete Lumbis f4a8981b63
move docs to content directory for hugo 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 2022-10-05 11:10:02 -04:00