Commit Graph

12 Commits

Author SHA1 Message Date
Pete Lumbis 1d676f8aad
Changes for moving docs source of truth (#243)
* Create new release issue template

Signed-off-by: Pete Lumbis <pete@upbound.io>

* add an issue title

Signed-off-by: Pete Lumbis <pete@upbound.io>

* indicate user should supply a version number

Signed-off-by: Pete Lumbis <pete@upbound.io>

* Remove publish directive

Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-10 18:03:00 -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
hasheddan 96bd1e6032
Expand Makefile targets to manage hugo and support build
Adds build and validation targets and automatically installs correct
version of hugo for consumers.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2022-10-12 15:09:57 -04:00
hasheddan 851bbdf68d
Add a run target for local development
Adds a run target for local development.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2022-10-12 14:08:38 -04:00
hasheddan 2ce30ba97c
Restore Makefile with only publish target
Crossplane needs the publish target to commit changes back to this repo,
so we restore the Makefile with only that functionality.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2022-10-10 17:17:40 -04:00
Pete Lumbis a63a63275f
remove jekyll related files
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:02 -04:00
Donovan Muller b6cf6b62f5 Pin jekyll/jekyll image tag to 3
Signed-off-by: Donovan Muller <donovan.muller@gmail.com>
2022-07-14 12:56:40 +02:00
Michael Goff f43f3f8969
Update Gemfile.lock
and provide a helper in the Makefile (`make bundle_update`) to
assist with this in the future.

Signed-off-by: Michael Goff <thephred@gmail.com>
2021-12-30 10:08:09 -08:00
Phil Prasek 8982957188
add incremental local docs option to makefile
Signed-off-by: Phil Prasek <prasek@gmail.com>
2020-10-08 08:14:37 -07:00
hasheddan 4cc08e4d96 Update go mod and refs with crossplane org name
Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2020-02-18 19:27:00 -06:00
Phil Prasek 32671fc3f3 Add make run_docs_local and update readme
Signed-off-by: Phil Prasek <prasek@gmail.com>
2019-09-16 09:36:50 -07:00
Michael Goff 2abb60d8e5
First version of the website. 2018-12-03 22:22:24 -08:00