Commit Graph

76 Commits

Author SHA1 Message Date
Jean du Plessis 7b7aeb0b7b Update Vale rules to accommodate site content
Signed-off-by: Jean du Plessis <jean@upbound.io>
2023-06-20 06:44:09 +02: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 0ebb281dc1
Create a popper.js element for slack notification
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-05-15 12:56:01 -04:00
Pete Lumbis e0d897441c
Fix XRD/CRD mixup (#435) 2023-05-09 15:21:05 -04:00
Pete Lumbis 4f213f50e7
Concepts: Provider rewrite (#420) 2023-05-05 16:50:47 -04:00
Jean du Plessis b203b5dc7d
Merge pull request #408 from plumbis/vale-updates-407 2023-04-20 23:55:05 +02:00
ezgidemirel 2c0b21701b
Update vault-as-secret-store.md with plugin changes (#409) 2023-04-19 14:23:43 -04:00
Pete Lumbis 5c3dce0b0d
Remove 'disabled' (#404) 2023-04-18 13:46:10 -04:00
Pete Lumbis 4b896ded90
remove 'alternatively'. Covered by write-good.TooWordy
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 10:36:48 -04:00
Pete Lumbis 3df7a40625
Add 'Enum'
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 09:28:58 -04:00
Pete Lumbis 6f637a1115
Remove 'simply' as a duplicate. Covered by alex.Condescending
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 09:21:26 -04:00
Pete Lumbis 6ad593ad4a
Promote to warning to catch 'please'
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 09:20:27 -04:00
Pete Lumbis 5a0f03af27
Disable duplicate rules. Google.Will is covered by gitlab.FutureTense. Google.Latin and Microsoft.Foreign covered by gitlab.LatinTerms
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 09:06:51 -04:00
Pete Lumbis b094c475c2
Remove 'the cloud' error.
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-04-18 09:03:16 -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 83e6e2e42d
AWS Quickstart Updates (#360) 2023-03-13 10:12:34 -04:00
Pete Lumbis 686070b8b4
GCP Quickstart Update (#369) 2023-03-13 10:10:50 -04:00
Pete Lumbis c3c578916e
Fix dark mode stylings (#379) 2023-03-06 14:38:02 -05:00
Pete Lumbis a80242ff8a
Add alpha/beta version information to alerts (#375) 2023-03-01 14:09:33 -05:00
Pete Lumbis dad3573e2e
Add style support for copy button highlighting (#372) 2023-03-01 14:04:37 -05:00
Pete Lumbis 6ddf91f0cb
Initial Vale style guidelines (#358) 2023-02-15 10:55:49 -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 96949f1612
Highlight codeblocks on hover (#238)
adds support for "hover highlight" in code blocks.
2022-12-28 13:58:45 -05:00
Pete Lumbis a1f6f69bcb
Code copy (Take 2) (#237)
Adds a copy to clipboard button using Clipboard.js
Optional support for defining which lines to copy out of the code box.
Adds styling and anchor links to the line numbers
Adds support to link to line number anchors inside tabs
Removes line numbers from tables (no user impact, changes styling and JS element targeting)
Makes the top NAV not sticky. This is required to make the line number anchors work. Otherwise the line number linked to will go under the navbar and not be in view. Fixing this with a sticky nav is a very large lift (for me). Also note, the side bars are still sticky.
Removes clipboard scsss files. All clipboard related styles are merged into code-theme-base.scss
Also applies Hugo caching fixes that can cause the stylesheet not to load in local dev (discovered in this PR)
2022-12-16 09:23:53 -05: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