Closed fykaa closed 6 days ago
Name | Link |
---|---|
Latest commit | 804c736150d88fdecb639e6541a817262ac65569 |
Latest deploy log | https://app.netlify.com/sites/docs-kargo-io/deploys/673773d187da7c0008eb20c9 |
Deploy Preview | https://deploy-preview-2930.docs.kargo.io |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 49.97%. Comparing base (
aa66473
) to head (804c736
). Report is 2 commits behind head on main.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Do we need to add further changes, like automating this process or handling additional edge cases?
Adding new pages or changing a page's title is an infrequent enough thing that the payoff for automating conversion to title case isn't worth the effort.
Also, should we add monotype texts for kargo resources?
Good question, and frequently a difficult one...
Even in titles, I use monospaced text if I am unquestionably referring to a type, variable, command, etc. There are many cases that aren't so black and white. Take "Working with Freight" as an example. Is this "Freight" as a concept (a bundle of artifacts) or is it the Freight
type? If you read the page, maybe it's actually a little bit of both. In this sort of case, it's hard to decide what's right and I would err on the side of whatever looks nicer. imho, for titles, if in doubt, don't monospace.
This comes up in a lot of other contexts, btw. Two great examples are "string" and "namespace," both of which arguably could be monospaced nearly everywhere you see them. But they're also frequently used words and well-understood concepts. If we go overboard monospacing those everywhere they occur, it needlessly calls attention to insignificant words which is more likely to annoy readers than to improve their understanding of anything.
In the end, there is no hard and fast rule here and in many cases, you just need to use your best judgement.
Here, I would personally err on the side of no.
There are still some issues:
Fixed
Successfully created backport PR for release-1.0
:
closes #2902
The current state of the docs adopts the label for each item in the following order of precedence
sidebar_label
field in the frontmatter of the.md
file (if explicitly provided)# heading
in the.md
file (ifsidebar_label
is absent).md
file (if neithersidebar_label
nor a# heading
is present)Given this behavior I have tried to address the issue by updating the markdown files to explicitly include titlecase in the
sidebar_label
field where it was missing.Do we need to add further changes, like automating this process or handling additional edge cases? Also, should we add monotype texts for kargo resources?