KU-2068 reformatted annotations table #789
Conversation
due to formatting issues the annotations table was quite unclear. Edited to make it more readable
|
This is a great improvement! I still think we can do better though |
adding example of how to include annotations in your cluster-config yaml file as requested in PR review
|
Update - there is no simple way to create the headings we want. The 'proper' way to do it would be to define a new style for the h2 headings and then apply it only to the headings on this page. However, the 'proper' way to do this is using the sphinx directive - cssclass. My next experiment was to create a div so I could apply a class that way and use that to style the headers. Sadly, even the ugly way of adding HTML to do this seems to break the theme (the footer floats into space). I think that leaves us with - the hacky way and the ugly, hacky way The hacky way is to include a blob of JS on this page which will rewrite the styles for headings, which I will try next. |
|
i think we can maybe bump up the size to 1.5em |
Co-authored-by: Nick Veitch <nick.veitch@canonical.com>
| k8sd/v1alpha/lifecycle/skip-cleanup-kubernetes-node-on-remove: true | ||
| k8sd/v1alpha/lifecycle/skip-stop-services-on-remove: true | ||
| ``` | ||
|
|
There was a problem hiding this comment.
might be nice to have some text here to ease the transition to the actual list of annotations
include link to kubernetes website with more info on annotations, make []string clearer to non golang users and include line between eg and list
|
Please rebase this PR. |
Due to formatting issues with large amounts of text, the annotations table was quite unclear. Edited to make it more readable