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

Enhance the help message #1409

Merged
merged 7 commits into from
Mar 15, 2024
Merged

Enhance the help message #1409

merged 7 commits into from
Mar 15, 2024

Conversation

mszostok
Copy link
Contributor

@mszostok mszostok commented Mar 8, 2024

Description

Changes proposed in this pull request:

  • Fix setting "Active Instance .." header to be visible only on start
  • Address helm message enhancements

Notes

I have such feedback regarding initial design:

  1. Cloud section:
    • add buttons instead of static text
  2. AI sections:
    • "Ask a question" - runs "@botkube ai hi!"
  3. Basic commands - all good ✅
  4. Notifications:
    • there is no "footer" with btns for all listed options - it's not consistent e.g. with "Basic commands" section
    • Change notification on Botkube Cloud -> Change notification on Cloud - too long to fit into button
      • it will open Instance View as we don't have any other view to link to
  5. Run kubectl commands:
    • there is no "footer" with btns for all listed options
  6. Multi-cluster flags:
    • the multi-cluster flags are disconnected from the context of setting default cluster per channel - w have that in the "Botkube cloud" section
  7. Advanced features section:
    • I don't understand the "[Executors and aliases] - run commands like helm, flux, etc. directly from Slack" what it actually means, where we should link to?
    • I don't think that we should scare our users and call it advanced features. It's not advanced tbh, we just still lack a good UX there, but the overall business functionality is straight forward.

Other:

  • what about helm(?) should we skip it?
  • what if we don't have any instance connected and someone runs botkube help?
    • in this case we return no instance connected
      Screenshot 2024-03-08 at 14 07 15

@miklosp PTAL, below you will find the original message and suggested with small adjustements

Slack

Original Suggested
Screenshot 2024-03-08 at 11 39 40 Screenshot 2024-03-08 at 13 03 32

Teams

Original Suggested
Screenshot 2024-03-08 at 11 58 47 Screenshot 2024-03-08 at 13 05 50

Testing

Run Botkube with all platforms and ask for help: @Botkube help

Related issue(s)

Resolves https://github.com/kubeshop/botkube-cloud/issues/916

@mszostok mszostok added the enhancement New feature or request label Mar 8, 2024
@mszostok mszostok force-pushed the update-help branch 6 times, most recently from c14171a to 389e9fe Compare March 8, 2024 13:33
@mszostok mszostok marked this pull request as ready for review March 8, 2024 13:33
@mszostok mszostok requested review from PrasadG193 and a team as code owners March 8, 2024 13:33
@mszostok mszostok requested a review from vaijab March 8, 2024 13:33
@miklosp
Copy link

miklosp commented Mar 11, 2024

@mszostok LGTM!

Copy link
Collaborator

@vaijab vaijab left a comment

Choose a reason for hiding this comment

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

Nice one!

@mszostok mszostok merged commit 66194a8 into kubeshop:main Mar 15, 2024
16 checks passed
@mszostok mszostok deleted the update-help branch March 15, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants