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.
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
docs(ui): full copy-edit of title & description page #12582
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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>
jmeridth
approved these changes
Jan 28, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it. File was misspelled. Lol. Good catch.
20 tasks
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Fixed codegen due to the filename typo fix |
This was referenced Jan 31, 2024
jmeridth
approved these changes
Feb 1, 2024
The missing version specifier popped up on Slack, so hoping this can get an Approver+ soon |
Another user confused on Slack by lack of version specifier... |
4 tasks
juliev0
approved these changes
Feb 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
area/docs
Incorrect, missing, or mistakes in docs
prioritized-review
For members of the Sustainability Effort
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partial fix for #10553 (review) -- this fixes the docs & example issues, while #12580 fixes the UI issues
Motivation
Significantly improve the "Title and Description" page (and related example) from #10553
title
was not very accessibleModifications
split the page into sections with and without markdown
add version specifiers to both of these sections
link to markdown docs when referencing Markdown
improve example descriptions
instead of having loose descriptions of rows in a list, actually write out the (partial) manifest that results in those renderings
accessibility improvements:
prose style improvements:
markdown style improvements:
example improvements:
Verification
make docs
open site/title-and-description/index.html
Took screenshots:
Future Work
Backport the non-markdown variant to the
release-3.5
andrelease-3.4
branches