Commit Graph

43 Commits

Author SHA1 Message Date
Pete Lumbis bff3de632c
Search index only for /latest (#423) 2023-05-01 10:12:39 -04:00
Pete Lumbis 5844fef0e5
Support dynamic GA tag (#425) 2023-04-29 14:01:31 -04:00
Pete Lumbis 69e625ddc5
create a custom 404 to list sections of available content (#424) 2023-04-29 14:00:04 -04:00
Pete Lumbis 58068b8480
Add a link to the Crossplane roadmap in the nav. (#396) 2023-04-12 10:20:51 -04:00
Pete Lumbis fc8125cf30
Script to clear or reset span contents for editable elements (#374) 2023-03-07 10:49:07 -05: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 607513a60d
Restore comp revision example guide (#367) 2023-02-23 12:46:10 -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 b8a54f32a2
Make entire sidebar menu clickable (#355)
Resolves https://github.com/crossplane/docs/issues/297
2023-02-10 12:28:05 -05:00
Pete Lumbis aa4efd300e
Fix mobility issues reported by Google Console (#352)
* remove hubspot analytics

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

* move large table output under an expand an inside a responsive table

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-02-09 19:20:12 -05:00
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
Pete Lumbis 1105d400a4
add conditionals based on product type (#318)
Resolves https://github.com/crossplane/docs/issues/314
2023-02-02 09:48:11 -05:00
Pete Lumbis 89633eab65
Add last changed metadata to pages for search (#324) 2023-02-02 09:39:45 -05:00
Pete Lumbis 32e3bfc64b
Enable optional line/field editing in code examples (#311) 2023-02-02 09:39:13 -05: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 247efca59c
Use Hugo anchorize to sanitize titles. Resolves #301 (#302)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-30 11:49:04 -05:00
Pete Lumbis dcab9883d6
Rework navbar. Simplify code and enable for support for KB and contrib (#267)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-24 09:37:47 -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 b191ce133d
Adds missing script import for search and sets docs param (#269)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 22:36:08 -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
Pete Lumbis a85f25c2de
Combine list and single page layouts into a single file. Add github and pencil icons. (#262)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 21:54:59 -05:00
Pete Lumbis 40ea0ed110
Moves the search box JS from end of page to search div (#259)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 21:53:57 -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 01ecdf0c9e
Update navbar Docs link to point to the BaseURL (#266)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 20:59:14 -05:00
Pete Lumbis d2e3778974
Updated favicons (#257)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-09 20:39:09 -05:00
Pete Lumbis ff7d6cc30a
Add notice for deploy-previews. Resolves #248 (#258)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-09 20:38:31 -05:00
Pete Lumbis 6bc295c31a
Support styling for bootstrap tables (#249)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-03 11:32:13 -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 9f9d28b0aa
Color and underline single commands that are also links (#244)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-29 14:08:58 -05:00
Pete Lumbis 4ade356697
Fix accordian header margin. Regression caused by the fix for #230 (#245)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-29 14:08:41 -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 adc2ec4098
Update heading font sizes and make them responsive with RFS. Resolves #230 (#241)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-16 12:43:57 -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 83fbecce6d
Fix spacing when browser size is below 1200px wide. Fixes #227 (#228)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-09 11:32:54 -05:00
Pete Lumbis 8035aeb336
Add incubating to CNCF label (#225)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-07 15:07:53 -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 7eca1c4a3d
Makes left-hand nav sticky. Resolves #218 (#221)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-05 17:09:05 -05:00
Pete Lumbis 4533f0abbe
Add collapsed class by default and update styles for X (#222)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-03 13:32:50 -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