Update README for predict launch in v1.100 #140
Conversation
|
@bstuder99 a review of the copy would be most welcome, if you have the time |
| > for examples. Let us know how it goes, and open an issue if you encounter any | ||
| > problems! | ||
|
|
||
| ‼️ New! Starting with Kubecost v1.100, `kubectl cost` can estimate the cost of undeployed changes! Try it |
There was a problem hiding this comment.
Not sure if exclamation marks in tech docs go well together. I'd like to hype this but I'm thinking we scale back the enthusiasm. Maybe: "New: As of Kubecost v1.100, ...of undeployed changes."
There was a problem hiding this comment.
I'd really like to have some color here, rather than just bolding. There's a lot to be said for a GitHub README that pops on first view, which is why we already have some GIFs. Do you think there's a way we could incorporate some eye-catching color (or some other mechanism) to draw attention to the new feature?
There was a problem hiding this comment.
Unless we want to use an image file (.png or .gif), which would be the most immediate implementation, we may have to look at third party plugins. I haven't implemented one of these in the past, but this should have what you're looking for:
https://docs.gitlab.com/ee/user/markdown.html
There was a problem hiding this comment.
What I mean to say is: emojis are an easy way to add color that are supported by default in GitHub markdown, which is why I went for some sort of emoji. Given that a README is half marketing landing page, half documentation, is an emoji inappropriate?
There was a problem hiding this comment.
Ah, I wasn't aware that was supposed to be an emoji. In general I would say we should avoid them in tech docs, but there are existing exceptions like on our 3-step Kubecost install page which I've received pushback on weirdly. For now, I'm just going to table this and try to find a consistent system of using these "banners" across our docs, just as in warnings.
michaelmdresser
force-pushed
the
mmd/predict-launch-readme
branch
from
37ecc2a
to
1fe2ae5
Compare
Signed-off-by: Michael Dresser <michaelmdresser@gmail.com>
What does this PR change?
LIVE PREVIEW OF README CHANGES: https://github.com/kubecost/kubectl-cost/blob/mmd/predict-launch-readme/README.md
Update of README to highlight
kubectl cost predictlaunch.@dwbrown2 can you comment on the copy/example/placement? I used a highly truncated example output to keep it snappy at the top -- there are more detailed examples later in the README already. I'm not very adept at design, so I'm welcoming all ideas.