Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(ui): full copy-edit of title & description page #12582

Merged
merged 2 commits into from
Feb 26, 2024
Merged

docs(ui): full copy-edit of title & description page #12582

merged 2 commits into from
Feb 26, 2024

Commits on Jan 28, 2024

  1. docs(ui): full copy-edit of title & description page 

    - split the page into sections with and without markdown
  - the non-markdown title & description feature was available earlier in 7c805fe
  - add a non-markdown example and description
  - add a simple markdown example of just one row
  - use the same width images for both of these examples for visual consistency with the larger example
- add version specifiers to both of these sections

- link to markdown docs when referencing Markdown
- improve example descriptions
  - fix missing end parenthesis
  - be more specific, for instance, one of the examples is multi-line

- instead of having loose descriptions of rows in a list, actually write out the (partial) manifest that results in those renderings
  - I "reverse-engineered" what they would be based on the image
  - remove extra / duplicated example at the end (?)
  - use one code block instead of multiple to make it easier to read

accessibility improvements:
- better describe the example image(s), specify that they are examples
  - previously, it just said "Workflow Title and Description", which would not really explain the image for someone using a screen reader, as that's the same as the title of the page

prose style improvements:
- use present tense and active voice, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense)
- be more simple and direct, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
- avoid jargon / idioms, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-jargon-and-idioms)
  - "auto turn" -> "convert"
- be specific, instead of "title and description annotations", specify what the annotations are

markdown style improvements:
- use ordered list when a list is ordered, instead of an unordered one

example improvements:
- add version specifier like other examples
- don't link to Couler, as it's been unmaintained for some time
  - instead link to these docs themselves -- a link this repo controls and a self reference
  - couldn't do that with the in-line example because I'd need to make a new image to correspond with that

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
    @agilgur5
    agilgur5 committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    a123e39 View commit details
    Browse the repository at this point in the history

  2. codegen fields.md due to the filename typo 

    Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
    @agilgur5
    agilgur5 committed Jan 28, 2024
    Configuration menu
    Copy the full SHA
    dd94e43 View commit details
    Browse the repository at this point in the history