Skip to content

kdash: add page #17154

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

kdash: add page #17154

wants to merge 3 commits into from

Conversation

Akasan
Copy link
Contributor

@Akasan Akasan commented Jul 7, 2025

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. new translation PRs translating a page(s) from English to other languages. review needed Prioritized PRs marked for reviews from maintainers. labels Jul 7, 2025
@tldr-bot
Copy link

tldr-bot commented Jul 7, 2025

The build for this PR failed with the following error(s):

pages/common/kdash.md:4: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.

Copy link
Member

@spageektti spageektti left a comment

Choose a reason for hiding this comment

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

Hi, thanks for your contribution


- Set the tick rate:

`kdash -t 100`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`kdash -t 100`
`kdash -t {{100}}`


- Set the polling rate:

`kdash -p 200`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`kdash -p 200`
`kdash -p {{200}}`

@Managor
Copy link
Member

Managor commented Jul 7, 2025

Consider submitting the translation after the english page has been merged so that we don't have to wait for translation maintainers to approve and so that fixes don't have to be applied multiple times.

Copy link
Member

@dmmqz dmmqz left a comment

Choose a reason for hiding this comment

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

Please also apply these changes to the Japanese translation.


- Show dashboard as debug mode and write logs:

`kdash -d`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`kdash -d`
`kdash {{[-d|--debug]}}`


- Set the tick rate:

`kdash -t 100`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`kdash -t 100`
`kdash {{[-t|--tick-rate]}} 100`

Comment on lines +18 to +20
- Set the polling rate:

`kdash -p 200`
Copy link
Member

@dmmqz dmmqz Jul 7, 2025

Choose a reason for hiding this comment

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

Polling rate must be used together with tick rate, where polling rate is a multiple of the tick rate (e.g. kdash -t 200 -p 400).

Please also add the long form option for -p (--poll-rate).

$ kdash -p 400
Error: 'Poll rate must be multiple of tick-rate' at src/main.rs:95:5

# kdash

> A simple terminal dashboard for Kubernetes.
> Mode information: <https://github.com/kdash-rs/kdash/>.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> Mode information: <https://github.com/kdash-rs/kdash/>.
> Mode information: <https://github.com/kdash-rs/kdash/#usage>.

Quite a lot of scrolling to get to the usage instructions. Consider this.

Co-authored-by: Wiktor Perskawiec <[email protected]>
@Akasan
Copy link
Contributor Author

Akasan commented Jul 8, 2025

Consider submitting the translation after the english page has been merged so that we don't have to wait for translation maintainers to approve and so that fixes don't have to be applied multiple times.

Thank you for your review.
That's true. It would be better to create the page in English first, and then translate it, which would reduce the number of changes. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. new translation PRs translating a page(s) from English to other languages. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants