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

Add some tips on effective watson usage #438

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

joelostblom
Copy link
Contributor

@joelostblom joelostblom commented Jun 6, 2021

I think it would be helpful to expand on the "getting started" section with some more pointers for how to be effective with watson. The ones suggested in this PR are obviously colored by how I use watson and I am happy for them to be replaced with something more general, or maybe better: for there to be a section where users can share their specific workflows (although that might be more hidden for people going to the website).

Fun groovy gifs like this one can be added if desired to match the cat:

I also fixed a typo I noticed when reading the docs.

Copy link
Contributor

@jmaupetit jmaupetit left a comment

Choose a reason for hiding this comment

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

Thank you for this @joelostblom! 🙏

I find it cool but a little bit too opinionated 😉 Maybe we should add a new "real world use cases" section in the documentation to introduce examples of Watson usage?

@@ -638,7 +638,7 @@ in the future.
Example:


$ watson start --at 13:37
$ watson start appollo11 --at 13:37
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$ watson start appollo11 --at 13:37
$ watson start apollo11 --at 13:37

@@ -230,7 +230,7 @@ def start(ctx, watson, confirm_new_project, confirm_new_tag, args, at_,
Example:

\b
$ watson start --at 13:37
$ watson start appollo11 --at 13:37
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$ watson start appollo11 --at 13:37
$ watson start apollo11 --at 13:37

@joelostblom
Copy link
Contributor Author

Haha yes, it is definitely opinionated =) I like the idea of real world usage scenarios, that's what I was trying to get at with my second suggestion. Where do you want that section? As a third entry in the "User guide" after "Commands" and "Configuration"?

I can add my story for now and change it to a more personal narrative and encourage others to share their tips/setup/workflows. I feel like this sharing of knowledge could be good for community building too, not sure about the exact format, but something like this:

These are examples from the community of how people use watson for their daily time tracking. Please feel free to share your own tips via a GitHub issue and we can add them here!

User 1/Example 1 (or name?)
...
User2/Example 2
.... etc

@jmaupetit
Copy link
Contributor

As a third entry in the "User guide" after "Commands" and "Configuration"?

Yes, good idea!

Few years ago, I wrote a narrative about Watson usage: https://tailordev.fr/blog/2016/02/05/a-day-tracking-my-time-with-watson/

Not sure it's still relevant now...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants