kubewarden / docs

Kubewarden's documentation
https://docs.kubewarden.io
Creative Commons Attribution 4.0 International
13 stars 23 forks source link

A better layout than tables in spec/host-capabilities #375

Closed jhkrug closed 6 months ago

jhkrug commented 6 months ago

Closes #374.

I had noticed that the host-capabilities pages in policy specification reference used tables for layout. Due to the fixed width content, these tables required a lot of horizontal scrolling and appear to be quite ugly.

Maybe something like this approach is better? As developers, which would you prefer?

I've used sections, rather than tables, and put the code parts in expandable details. Unfortunately, Ctrl-f doesn't work on strings inside unexpanded details sections, so that's not great.

When we have decided on an approach (or decide to keep the current layout), I'll do the rest of the files in this section that have similar layout.

So, experimental, draft PR. Preferences?

New page: https://deploy-preview-375--silly-bunny-8cedd0.netlify.app/next/reference/spec/host-capabilities/signature-verifier-policies

Old page: https://deploy-preview-375--silly-bunny-8cedd0.netlify.app/writing-policies/spec/host-capabilities/signature-verifier-policies

netlify[bot] commented 6 months ago

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
Latest commit 3a39a755f3bc816d63b60cd2259bd5cff67a6434
Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/65fc1d3913150c000817b1f1
Deploy Preview https://deploy-preview-375--silly-bunny-8cedd0.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jhkrug commented 6 months ago

Ok, I shall do the rest of the section.

jhkrug commented 6 months ago

I decided not to use the <details> expander thingie, retaining the ability to Ctrl-F search. It's still much better than the tables though.

jhkrug commented 6 months ago

Moved back to draft while I make some consistency changes.