Commit Graph

15 Commits

Author SHA1 Message Date
Jared Watts b700d41276
Wrap README.md lines
Signed-off-by: Jared Watts <jbw976@gmail.com>
2023-02-03 18:03:58 -08:00
Jared Watts d9e33b1f28
Update link to docs contributing guide in README.md
Signed-off-by: Jared Watts <jbw976@gmail.com>
2023-02-03 18:00:54 -08:00
Nic Cope 2a9e5e7581 Fix link to docs.crossplane.io
Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-01-23 18:01:32 -08:00
Nic Cope d8d354ed7b Clarify that this repo is only the docs
I was making a fresh clone of this repo when I saw that it was forked
from crossplane.github.io and stated in the README that it was both the
website and docs. This surprised me, since crossplane/docs seemed like a
misleading place to find the website.

I then learned that the website is in fact a separate repo, at
https://github.com/crossplane/website

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-01-23 17:53:39 -08:00
Pete Lumbis f549b8cdbc
add Browserstack testing notice for ownership verification (#256)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-06 12:08:15 -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
Aleksey Zhukov 2c1089c51e
Update README.md
Fix a link. Currently it leads to 404 on `https://github.com/crossplane/crossplane.github.io/blob/master/crossplane.io`

Signed-off-by: Aleksey Zhukov <353748+alezkv@users.noreply.github.com>
2022-10-21 00:01:57 +02: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
Jared Watts 24ca969693
Add licenses for this repo
* Source code is under Apache 2.0 license
* Documentation distributed under CC-BY-4.0
* README clarifies between the two

Signed-off-by: Jared Watts <jbw976@gmail.com>
2021-01-06 10:09:16 -08:00
Jared Watts 8660cb9d3d
readme: instructions for how to live preview changes to this repo
Signed-off-by: Jared Watts <jbw976@gmail.com>
2020-11-24 17:38:12 -08:00
Connor Chan b28b4e6d04
Update messaging and content
Signed-off-by: Connor Chan <connorjosephchan@gmail.com>
2020-10-28 13:15:38 -07: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