Commit Graph

16 Commits

Author SHA1 Message Date
Pete Lumbis 2b598cb79f
Remove knowledge base section (#755)
Remove KB and add redirects
2024-04-22 15:44:32 -04:00
Pete Lumbis 6feb7ce6fc
add RSS support for release notes. Resolves #629 (#638) 2023-12-01 12:11:39 -05:00
Nic Cope cb1f9d2f9c Add support for Mermaid diagrams
Per instructions from Hugo:
https://gohugo.io/content-management/diagrams/#mermaid-diagrams

The styling could probably be updated to be more in line with the rest
of the docs, but this already looks better to me than the goat ASCII
diagrams Hugo supports out of the box.

Signed-off-by: Nic Cope <nicc@rk0n.org>
2023-10-27 19:23:12 -07:00
Pete Lumbis 480b7e9232
Remove included pages from local search and search engines (#542) 2023-09-01 14:36:32 +00:00
Pete Lumbis 32415fbb30
create a unique navbar cache for the homepage
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-05-15 12:55:19 -04:00
Pete Lumbis fb5c5a8ea5
add search to the home page. (#421) 2023-05-12 16:02:03 -04:00
Pete Lumbis bff3de632c
Search index only for /latest (#423) 2023-05-01 10:12:39 -04: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
Pete Lumbis 3bb7b665fe
Create a home landing page and styling to stage for v1.11 reorg (#268)
* Create a home landing page and styling to stage for v1.11 reorg

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

* Fix spacing

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

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 22:41:24 -05:00
Pete Lumbis d6b32b36c1
Alert when a feature is alpha/beta (#263)
* Combine list and single page layouts into a single file

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

* Add an alert for features that are tagged alpha/beta.

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

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 21:43:56 -05:00
Pete Lumbis d0093bb333
Removes links to docs user survey (#253)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-03 10:56:47 -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 37748344fa
Add a survey banner (#231)
* add survey banner
2022-12-15 15:41:22 -05:00
Pete Lumbis dd80b838c5
Adds Algolia DocSearch components and manual style overrides (#226)
* Adds Algolia DocSearch components and manual style overrides

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

* Auto close menu on mobile when search box is clicked

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

* Add search hotkey indicators

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

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-09 13:20:25 -05:00
Pete Lumbis dca8be26ca
Rebuild styles and layout for Navbar to match www.crossplane layout. Address #217 (#223)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-05 17:09:25 -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