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.

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

feat: update inline hints and tips #1021

Merged
merged 7 commits into from
Feb 19, 2025
Merged

feat: update inline hints and tips #1021

merged 7 commits into from
Feb 19, 2025

Conversation

tnolet
Copy link
Member

@tnolet tnolet commented Feb 18, 2025

I hereby confirm that I followed the code guidelines found at engineering guidelines

Affected Components

  • CLI
  • Create CLI
  • Test
  • Docs
  • Examples
  • Other

Notes for the Reviewer

  • adds a hint on relevant reporters to use --record if the user did not use it when running test or trigger
  • adds a copy & pastable hint on updating the CLI when there is a new version.
  • small wording updates to other parts.

CleanShot 2025-02-18 at 14 32 17@2x

CleanShot 2025-02-18 at 14 51 50@2x

Resolves #1018
Resolves #973

@tnolet tnolet changed the title Tnolet/hints and qol sc00 tnolet/record-hints-and-qol Feb 18, 2025
@tnolet tnolet requested review from sorccu and removed request for sorccu February 18, 2025 13:33
@tnolet tnolet requested a review from sorccu February 18, 2025 13:56
@sorccu
Copy link
Contributor

sorccu commented Feb 18, 2025

Tangentially related but we should really add that update warning for the create-cli. After you've installed it once it's basically guaranteed to stay the same version unless you lose your package cache somehow (by e.g. updating node). I guess we as the developers are more exposed to that rather than real users who might only ever run it once, but there may be some who try us out, leave, and then come back months later. If they just follow our docs (npm create checkly) it'll use whatever old version of the create-cli they already had installed and the user is not informed of that either. Worst case the version they had (and still have) is buggy, they see no improvement and they leave again. It would also be nice if our docs used npm create checkly@latest instead which would be another way to solve the problem.

@tnolet
Copy link
Member Author

tnolet commented Feb 18, 2025

Tangentially related but we should really add that update warning for the create-cli. After you've installed it once it's basically guaranteed to stay the same version unless you lose your package cache somehow (by e.g. updating node). I guess we as the developers are more exposed to that rather than real users who might only ever run it once, but there may be some who try us out, leave, and then come back months later. If they just follow our docs (npm create checkly) it'll use whatever old version of the create-cli they already had installed and the user is not informed of that either. Worst case the version they had (and still have) is buggy, they see no improvement and they leave again. It would also be nice if our docs used npm create checkly@latest instead which would be another way to solve the problem.

I think we should indeed update all the links for to npm create checkly@latest. I will mark that on my list.

@tnolet
Copy link
Member Author

tnolet commented Feb 19, 2025

@sorccu I've updated some parts to npm create checkly@latest where relevant. I will proceed to also update our docs site and the marketing site. Can you review when convenient?

@tnolet tnolet added this to the 5.0.x milestone Feb 19, 2025
Copy link
Contributor

@sorccu sorccu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@sorccu
Copy link
Contributor

sorccu commented Feb 19, 2025

But can you change the title to be more suitable for the changelog?

@tnolet tnolet changed the title tnolet/record-hints-and-qol feat: update inline hints and tips Feb 19, 2025
@tnolet tnolet merged commit cf84500 into main Feb 19, 2025
3 checks passed
@tnolet tnolet deleted the tnolet/hints-and-qol-sc00 branch February 19, 2025 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants