Website: style release notes, docsy theme, table text overlap

Created on 16 Jun 2020  路  14Comments  路  Source: kubernetes/website

This is a Bug Report
Since adding the docsy theme, the tables in the v1.18 release notes display with errors.

Problem:
The table data overflows into the right hand column (TOC).

Proposed Solution:
Investigate wrapping the table text.

Page to Update:
https://kubernetes.io/docs/setup/release/notes/#downloads-for-v1-18-0

areweb-development kinbug prioritimportant-soon

All 14 comments

/kind bug
/priority important-soon

Could we specially style the <code> elements for checksums to allow them to break inside the word for wrapping?

That means we need some tricks to identify checksums?

@kbhawkey Suppose you are hacking the generation of release notes ... you will be generating an "annotated" markdown so that a special class is associated with the checksum string? I'd suggest we try tackle this by tweaking the CSS, given that pages like https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/ are also suffering from this issue.

I _think_ I could make a (mainly) CSS change that doesn't require changes to release note generation, and is fairly robust.

I am not proposing to modify the generation of the release notes. I simply added the link to the release notes tooling for some background information.
There are a number of problems with the tool reference pages:
The table data font size, table rows (stripes), missing right hand TOC, tables on the site are missing borders.

@sftim Another option for display would be to have tables scroll horizontally once they hit their max-width, i.e. like this.

This would be a relatively simple fix and would serve us well for a number of scenarios.

/assign @Arhell

/area web-development

@Arhell do you think any more work is needed here?

@sftim no, tnxs.

/close

Done in #22167

@sftim: Closing this issue.

In response to this:

/close

Done in #22167

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sftim picture sftim  路  3Comments

neha-viswanathan picture neha-viswanathan  路  3Comments

gochist picture gochist  路  3Comments

ahmetb picture ahmetb  路  4Comments

shruthibhaskar picture shruthibhaskar  路  3Comments