xdmod icon indicating copy to clipboard operation
xdmod copied to clipboard

Updated summary charts howto, added color palette howto.

Open Macman1234 opened this issue 2 years ago • 2 comments

Description

This PR changes the summary charts howto to use the Metrics Explorer json export function, and added more details about where summary charts are set from. The article is reorganized slightly to better flow sequentially through steps. It also adds a new howto for how to set up colors1.json for custom colors. It adds both of these to the Howto root article and changes the styling of that article slightly.

Motivation and Context

The existing summary chart howto explains the method for pulling chart JSON data out of the user database, which is cumbersome and not possible to do without administrator access. The user dashboard guide has instructions on how to get the chart from Metric Dashboard directly, which works great for this use case with some modifications. The existing howto also didn't include info about the roles.d/jobs.json field adding charts for logged-in users, which threw me off when trying this on my instance of Open XDMoD.

Currently there's no documentation on how to edit colors1.json - though it's mostly self-explanatory, it took me a bit to figure out how to get gradients working for different elements of a dataset. I figured some documentation might save people time if they're trying to do the same.

Tests performed

I wasn't able to replicate the Jekyll/gh-pages setup that https://open.xdmod.org/10.5/ seems to run on, but I looked through these in a standard Markdown viewer and they look good. They match the formatting of other articles, and follow the documentation conventions

Checklist:

  • [x] The pull request description is suitable for a Changelog entry
  • [ ] The milestone is set correctly on the pull request
  • [ ] The appropriate labels have been added to the pull request

Macman1234 avatar Feb 08 '24 20:02 Macman1234

The changes you made look great. I just had a few minor suggestions about some wording for some parts related to roles.d.

Applied! I was unaware XDMoD is looking for the specific realm .json files.

I think you also have some linter errors for extra whitespace characters at the end of some lines.

Thanks for the catch! My linter was turned off - fixed now.

Macman1234 avatar Jun 21 '24 02:06 Macman1234

I ended up making some changes to what you had suggested. It should still all be in line with the recommended method of creating a new JSON file to store any new summary charts. Let me know how it's looking.

I also fixed some more linter issues in the color article.

Macman1234 avatar Jul 03 '24 19:07 Macman1234

Everything looks good to me. Thank you for the contribution!

Thanks for the help on this, Andrew!

FYI, I don't have write access and so can't merge this myself. I assume there are other things that happen before this gets merged, but wanted to make sure you knew I couldn't do that.

Macman1234 avatar Jul 25 '24 20:07 Macman1234

Everything looks good to me. Thank you for the contribution!

Thanks for the help on this, Andrew!

FYI, I don't have write access and so can't merge this myself. I assume there are other things that happen before this gets merged, but wanted to make sure you knew I couldn't do that.

Thanks for the heads up. Merging this now.

aestoltm avatar Jul 26 '24 15:07 aestoltm