Commit Graph

61 Commits

Author SHA1 Message Date
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
hasheddan 3b613b5e51
Fix latest tag overlapping with version
Fixes the latest tag overlapping with the version in the selector.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2022-10-31 10:29:30 -04:00
hasheddan 4abced74c3
Format CSS to be more developer friendly
Uses prettier to format CSS to be more friendly for developers to
interact with.

Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2022-10-31 10:27:34 -04:00
Pete Lumbis 01034751e5
Corrects the check to see if this doc is for the latest version. Caused by versions param being a string now
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-27 13:22:53 -04:00
Pete Lumbis f86a1b3d82
ensure include file exists or error
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-20 16:27:41 -04:00
Pete Lumbis cab7cad723
Merge pull request #169 from upbound/shortcodes
add placeholder shortcodes
2022-10-18 20:13:08 -04:00
Pete Lumbis a679a8500c
add placeholder shortcodes for upcoming redesign work and new content ported from Upbound docs
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-18 19:56:42 -04:00
Pete Lumbis 04abc454f8
Fix version drop down by sorting version strings instead of floats
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-13 22:04:49 -04:00
Pete Lumbis 93e2612a7a
removes trailing slash from community link fixing 404 error
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-10 21:12:57 -04:00
Pete Lumbis 2e9cab63f1
Pass page context to version alert partial. This broke during the deploy fixes. Resolves #42
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-10 09:59:41 -04:00
Pete Lumbis 21c5470488
update links to reflect new URL schemes
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-10 09:38:14 -04:00
Pete Lumbis 0a00dc4bb1
Updates the /docs redirect to always go to what is globally defined as the latest version
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-07 18:08:22 -04:00
Pete Lumbis 21f07337ed
update link to docs root
Signed-off-by: Pete Lumbis <plumbis@users.noreply.github.com>
2022-10-07 17:50:44 -04:00
Pete Lumbis f81ae95e57
move docs content to /docs. Update left nav menu and dropdown menu for new layout
Signed-off-by: Pete Lumbis <plumbis@users.noreply.github.com>
2022-10-07 17:43:56 -04:00
Pete Lumbis c4c6013bda
corrects regex error for pages with 'v' in the URL
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:06 -04:00
Pete Lumbis b63dd4ea32
correcting hugo directory name to default/
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:06 -04:00
Pete Lumbis f0b844802c
new hugo shortcodes to generate docs tabs
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:06 -04:00
Pete Lumbis d80309f8dd
base template overrides for 404 page
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:06 -04:00
Pete Lumbis 6e3ec78d80
new template to provide HTTP redirect for API pages
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis f7268f7d50
base template overrides for index page
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis f85ebc36ed
base template overrides for community page
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis da7cd111cb
new template components specific to docs pages
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis 6496372aef
Update with plain CSS files
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis 239c818826
rename to css
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis 175210a560
Update favicon bundle
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:05 -04:00
Pete Lumbis b42c6403c9
add new smaller template components
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:04 -04:00
Pete Lumbis 4928bd8c98
add explicit https location for URL to avoid JS errors
Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-10-05 11:10:04 -04:00