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

Document show_host_usage configuration option in README #218

Merged
merged 4 commits into from
Aug 28, 2024

Conversation

pinksi
Copy link
Contributor

@pinksi pinksi commented Oct 6, 2023

This PR updates the readme file and add the information about the custom configuration feature to show or hide the information in sidebar or tachometer showing Kernel and host usage information.

README.md Outdated
enough to click `tachometer` icon on the right sidebar.
enough to click `tachometer` icon on the right sidebar.

If you want to show or hide information from the Kernel Usage sidebar
Copy link
Collaborator

Choose a reason for hiding this comment

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

Given the example sets it to Falsemaybe just:

Suggested change
If you want to show or hide information from the Kernel Usage sidebar
If you want to hide information from the Kernel Usage sidebar

README.md Outdated
@@ -143,6 +148,11 @@ causes "lag"/pauses in the UI. To workaround this you can disable Prometheus met
--ResourceUseDisplay.enable_prometheus_metrics=False
```

### Show or Hide information from sidebar (tachometer)
If you want to show or hide information from the Kernel Usage sidebar
Copy link
Collaborator

Choose a reason for hiding this comment

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

The same suggestion on wording here. Did it need to be reported twice or could one section link to the other?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, I think once should be enough.

@krassowski krassowski changed the title updates readme with show_host_usage feature Document show_host_usage configuration option in README Aug 28, 2024
Copy link
Collaborator

@krassowski krassowski 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 @pinksi!

@krassowski krassowski merged commit dd256e8 into jupyter-server:main Aug 28, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants