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: add how-to for accessing Grafana dashboard #8

Merged
merged 4 commits into from
Aug 5, 2024

Conversation

NucciTheBoss
Copy link
Member

This PR adds the how-to for accessing the Grafana dashboard after connecting the cluster workload manager to COS.

The PR also updates some of the how-to titles to flow a bit better and be less terse, and updates the site navigation. I also made updates to documentation website landing page. The how-to card now includes links to the current how-to sections that we have.

I also added a warning admonition to the landing page about how Charmed HPC is in pre-alpha. The purpose for adding this admonition is that we're still stabilizing some bits with the exporter (we need a Debian package for it) and the COS enabled Slurm charms haven't been rolled into stable yet. It would be good to include a "buyer beware" message, but also invite folks to help by testing things out as early adopters.

Page previews

New how-to

image

Updated landing page

image

Signed-off-by: Jason C. Nucciarone <[email protected]>
Copy link
Contributor

@jedel1043 jedel1043 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! Just needs to pass CI. Also, maybe some commits like the title changes and other fixes should be squashed into a single commit.

@NucciTheBoss
Copy link
Member Author

Looks good! Just needs to pass CI. Also, maybe some commits like the title changes and other fixes should be squashed into a single commit.

Coolio - I'll squash the smaller commits into one docs: update site navigation commit and fix the Github typo ⚒️

Signed-off-by: Jason C. Nucciarone <[email protected]>

docs: hide toctree so nav name isn't shown

- "How to __" reads better and is less terse.

Signed-off-by: Jason C. Nucciarone <[email protected]>

docs: change deploy workload manager how-to title

Signed-off-by: Jason C. Nucciarone <[email protected]>

docs: add reference to access grafana how-to

Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss NucciTheBoss force-pushed the howto-access-grafana branch from 6463dea to 3209664 Compare August 5, 2024 17:47
@NucciTheBoss
Copy link
Member Author

Fixed CI failures and rebased title commits into single commit so I will go ahead with merging.

@NucciTheBoss NucciTheBoss merged commit 72f1ede into charmed-hpc:main Aug 5, 2024
1 check passed
@NucciTheBoss NucciTheBoss deleted the howto-access-grafana branch November 21, 2024 21:22
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