Commit Graph

299 Commits

Author SHA1 Message Date
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
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
Jean du Plessis 8cebc09e28 Fix broken link to api reference
Signed-off-by: Jean du Plessis <jean@upbound.io>
2023-02-07 16:47:50 +02:00
Jean du Plessis 4b8a199e53
Merge pull request #332 from paulfantom/fix-link 2023-02-06 15:39:43 +02:00
Pete Lumbis 49e2583aed
fix helm link, remove include
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-02-05 20:52:31 -05:00
Paweł Krupa (paulfantom) eff801022d content/v.1.11: do not quote links as it leads to 404s
Signed-off-by: Paweł Krupa (paulfantom) <pawel@krupa.net.pl>
2023-02-03 15:00:36 +01: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 32e3bfc64b
Enable optional line/field editing in code examples (#311) 2023-02-02 09:39:13 -05:00
Pete Lumbis 542668be7b
Fix broken image in composite function guide (#312) 2023-02-01 14:42:31 -05:00
Clément Blaise 41f0fd3fe8
Fix EnvironmentConfigs Selector (#309)
Fix https://github.com/crossplane/docs/issues/308
2023-02-01 13:41:20 -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
Bartul Bonacic 121093ddbd
Update azure-provider.md (#296)
Azure CLI report following error if `az ad sp create-for-rbac` command is executed without specifying `--scope`:
`Usage error: To create role assignments, specify both --role and --scopes.`

Signed-off-by: bartul <bartul.bonacic@live.com>

Signed-off-by: bartul <bartul.bonacic@live.com>
2023-01-24 10:24:19 -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 c1c1cc386c docs snapshot for crossplane version `v1.10` 2022-12-13 14:38:36 +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 5e0987e2ff docs snapshot for crossplane version `v1.9` 2022-12-12 22:20:45 +00:00
Crossplane 3a4124b130 docs snapshot for crossplane version `v1.10` 2022-12-12 22:19:10 +00:00
Crossplane d545e5b01d docs snapshot for crossplane version `v1.8` 2022-12-12 22:18:46 +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 88ccc41967 docs snapshot for crossplane version `v1.10` 2022-12-03 14:35:38 +00:00
Crossplane a469573353 docs snapshot for crossplane version `master` 2022-12-03 14:34:28 +00:00
Crossplane 9f719f15e7 docs snapshot for crossplane version `v1.10` 2022-12-02 15:38:55 +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 77f7c3401a docs snapshot for crossplane version `v1.10` 2022-12-02 12:58:03 +00:00
Crossplane 90db6ed8f6 docs snapshot for crossplane version `master` 2022-12-01 22:07:34 +00:00
Crossplane b5ae460f09 docs snapshot for crossplane version `v1.9` 2022-12-01 21:48:38 +00:00
Crossplane ec79756e2b docs snapshot for crossplane version `v1.10` 2022-12-01 21:47:53 +00:00
Crossplane 537b881736 docs snapshot for crossplane version `v1.8` 2022-12-01 21:47:31 +00:00
Crossplane dd68f7e9dc docs snapshot for crossplane version `master` 2022-12-01 17:18:34 +00:00
Crossplane 6d1813ebb7 docs snapshot for crossplane version `v1.9` 2022-12-01 17:04:14 +00:00
Crossplane 64e9a1b77f docs snapshot for crossplane version `v1.10` 2022-12-01 16:51:55 +00:00
Crossplane 2cf952e84a docs snapshot for crossplane version `v1.8` 2022-12-01 16:35: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
Crossplane 6c606dcbef docs snapshot for crossplane version `master` 2022-12-01 14:19:51 +00:00
Crossplane df2ab44041 docs snapshot for crossplane version `master` 2022-11-30 01:56:07 +00:00
Crossplane b41b8c6d48 docs snapshot for crossplane version `v1.10` 2022-11-30 01:38:31 +00:00
Crossplane cee2291c5b docs snapshot for crossplane version `master` 2022-11-28 22:33:05 +00:00
Crossplane a480f43bfd docs snapshot for crossplane version `master` 2022-11-28 17:22:15 +00:00
Crossplane 1620c20c06 docs snapshot for crossplane version `v1.10` 2022-11-28 17:13:00 +00:00
Crossplane 6cef36f23f docs snapshot for crossplane version `master` 2022-11-23 09:34:42 +00:00
Crossplane f4c5f5d858 docs snapshot for crossplane version `master` 2022-11-18 23:43:42 +00:00
Crossplane d8b0918321 docs snapshot for crossplane version `master` 2022-11-18 00:25:50 +00:00
Crossplane 874f21a0e4 docs snapshot for crossplane version `v1.9` 2022-11-10 12:37:17 +00:00
Crossplane dbe3dde913 docs snapshot for crossplane version `v1.8` 2022-11-10 12:31:56 +00:00
Crossplane 10ec29e0e6 docs snapshot for crossplane version `v1.10` 2022-11-10 12:31:33 +00:00
Crossplane e10418da19 docs snapshot for crossplane version `master` 2022-11-10 11:36:00 +00:00
Crossplane 631802512c docs snapshot for crossplane version `master` 2022-11-07 08:52:07 +00:00
Crossplane b721885a5c docs snapshot for crossplane version `master` 2022-11-02 11:24:12 +00:00
Crossplane 5a3ed2d74b docs snapshot for crossplane version `v1.7` 2022-11-01 14:24:50 +00:00
Crossplane c3e30568d0 docs snapshot for crossplane version `v1.10` 2022-10-31 22:10:16 +00:00
Crossplane e24ea71b78 docs snapshot for crossplane version `master` 2022-10-25 17:57:15 +00:00
Crossplane aaeaa47af5 docs snapshot for crossplane version `v1.10` 2022-10-20 13:52:38 +00:00
Crossplane 18a2423725 docs snapshot for crossplane version `master` 2022-10-20 13:12:56 +00:00
Crossplane 96847cef62 docs snapshot for crossplane version `v1.10` 2022-10-18 09:45:50 +00:00
Crossplane 9e04b5c80d docs snapshot for crossplane version `v1.10` 2022-10-18 08:28:21 +00:00
Crossplane ae0c6218e3 docs snapshot for crossplane version `v1.9` 2022-10-17 13:45:16 +00:00
Crossplane 0926954a00 docs snapshot for crossplane version `v1.9` 2022-10-17 10:38:07 +00:00
Crossplane 4da9ac7a11 docs snapshot for crossplane version `v1.9` 2022-10-14 01:35:26 +00:00
Crossplane cc1c4b5587 docs snapshot for crossplane version `v1.8` 2022-10-14 01:35:11 +00:00
Crossplane 782785518f docs snapshot for crossplane version `v1.7` 2022-10-14 01:34:55 +00:00
Crossplane 7decd43ebd docs snapshot for crossplane version `v1.10` 2022-10-14 01:34:10 +00:00
Crossplane d6bb4fe88e docs snapshot for crossplane version `v1.10` 2022-10-14 00:11:16 +00:00
Crossplane 690de145d3 docs snapshot for crossplane version `master` 2022-10-13 22:11:30 +00:00
Crossplane b74c98006d docs snapshot for crossplane version `master` 2022-10-13 00:30:19 +00:00
Crossplane 1a34c00b2a docs snapshot for crossplane version `master` 2022-10-12 21:46:44 +00:00
Crossplane ae5e53ba0e docs snapshot for crossplane version `v1.10` 2022-10-12 16:11:48 +00:00
Crossplane 6a2bf1aa86 docs snapshot for crossplane version `v1.10` 2022-10-12 13:23:55 +00:00
Crossplane f4f0f12932 docs snapshot for crossplane version `v1.8` 2022-10-11 14:32:36 +00:00
Crossplane 80a19ecdcf docs snapshot for crossplane version `v1.9` 2022-10-11 14:30:09 +00:00
Crossplane dca9f57b72 docs snapshot for crossplane version `v1.7` 2022-10-11 14:27:51 +00:00
Crossplane 86391397c0 docs snapshot for crossplane version `master` 2022-10-11 11:29:57 +00:00
Crossplane e5b950162d docs snapshot for crossplane version `master` 2022-10-10 21:42:39 +00:00
Pete Lumbis 21c5470488
update links to reflect new URL schemes
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-10 09:38:14 -04:00
Pete Lumbis 0a00dc4bb1
Updates the /docs redirect to always go to what is globally defined as the latest version
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-07 18:08:22 -04:00
Pete Lumbis b49ad85c67
update link to docs root
Signed-off-by: Pete Lumbis <plumbis@users.noreply.github.com>
2022-10-07 17:50:35 -04: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 b4d2128d45
fix merge conflict
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:08 -04:00
Pete Lumbis 02bb32c0d7
add alias for /docs
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:07 -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 4f460fb2de
update to sync with upstream docs snapshots
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:07 -04:00
Pete Lumbis ad554546c2
404 page type to generate 404.html for webhosting service
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:06 -04:00
Pete Lumbis ab8bf8b119
move community page into hugo content directory
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:03 -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