chore(get-started): formatting of terms and phrases in guides/_subsections/navigate-the-dashboard.md

[aali309]

fixes: #120

[mwangggg]

https://github.com/aali309/cryostatio.github.io/blob/bed2af3d125d75d9564f6215ca8b4d9716429c5a/guides/_subsections/automated-analysis.md?plain=1#L2 automated-analysis.md references Cryostat and JMC a few times, but they aren't bolded like they are in other docs

[mwangggg]

https://github.com/aali309/cryostatio.github.io/blob/bed2af3d125d75d9564f6215ca8b4d9716429c5a/guides/_subsections/common/navigate-to-settings.md?plain=1#L2 might need some updates like "Settings view" and "Cryostat backend server"

[mwangggg]

I think I'm confused what should be in code blocks and what shouldn't be. In Thuan's original comment in the issue, he says that "user-named" data should be in code blocks so I'm not sure whether "Recording" should be in code blocks if it's referring to recording data or recording options? Also other things like "JSON", "snapshot", and "archived recordings" even.... maybe we've changed the idea of what should be in code blocks? I'm just gonna pause on reviewing the rest until this is cleared up :)

[aali309]

https://github.com/aali309/cryostatio.github.io/blob/bed2af3d125d75d9564f6215ca8b4d9716429c5a/guides/_subsections/automated-analysis.md?plain=1#L2 automated-analysis.md references Cryostat and JMC a few times, but they aren't bolded like they are in other docs

Yah for this @andrewazores was working on it and also requires new updated screenshots for this part. I can add them as part of this PR?

[aali309]

I think I'm confused what should be in code blocks and what shouldn't be. In Thuan's original comment in the issue, he says that "user-named" data should be in code blocks so I'm not sure whether "Recording" should be in code blocks if it's referring to recording data or recording options? Also other things like "JSON", "snapshot", and "archived recordings" even.... maybe we've changed the idea of what should be in code blocks? I'm just gonna pause on reviewing the rest until this is cleared up :)

Yes, a little bit. Thuan was just making a suggestion on how we should approach updating terms and phrases. The approach I took earlier was using code blocks for important terms/key words/nouns to help the user focus. so things like Recornings a noun will help the user focus. All screen navigation/clicks/selectable and related items are italicized. And terms like Cryostat, JVM and related terms are all in Bold. Your review above was amazing and matched what I was hoping to achieve. Its only because I have been working on guides for too long and all words look the same at some point :)

[mwangggg]

I think I'm confused what should be in code blocks and what shouldn't be. In Thuan's original comment in the issue, he says that "user-named" data should be in code blocks so I'm not sure whether "Recording" should be in code blocks if it's referring to recording data or recording options? Also other things like "JSON", "snapshot", and "archived recordings" even.... maybe we've changed the idea of what should be in code blocks? I'm just gonna pause on reviewing the rest until this is cleared up :)

Yes, a little bit. Thuan was just making a suggestion on how we should approach updating terms and phrases. The approach I took earlier was using code blocks for important terms/key words/nouns to help the user focus. so things like Recornings a noun will help the user focus. All screen navigation/clicks/selectable and related items are italicized. And terms like Cryostat, JVM and related terms are all in Bold. Your review above was amazing and matched what I was hoping to achieve. Its only because I have been working on guides for too long and all words look the same at some point :)

Ok thanks! I'll keep this in mind as I review the rest :)

[andrewazores]

https://github.com/aali309/cryostatio.github.io/blob/bed2af3d125d75d9564f6215ca8b4d9716429c5a/guides/_subsections/automated-analysis.md?plain=1#L2 automated-analysis.md references Cryostat and JMC a few times, but they aren't bolded like they are in other docs

Yah for this @andrewazores was working on it and also requires new updated screenshots for this part. I can add them as part of this PR?

I am just finalizing reviewing all the written content to see if any other content changes are required, but I already went through the automated analysis one in #158 . So if it needs further formatting/styling changes, they can be done now (as part of this PR or as a follow-up).

[aali309]

https://github.com/aali309/cryostatio.github.io/blob/bed2af3d125d75d9564f6215ca8b4d9716429c5a/guides/_subsections/automated-analysis.md?plain=1#L2 automated-analysis.md references Cryostat and JMC a few times, but they aren't bolded like they are in other docs

Yah for this @andrewazores was working on it and also requires new updated screenshots for this part. I can add them as part of this PR?

I am just finalizing reviewing all the written content to see if any other content changes are required, but I already went through the automated analysis one in #158 . So if it needs further formatting/styling changes, they can be done now (as part of this PR or as a follow-up).

I think the automated-analysis needs to be updated further, specifically the section 6 Download the Report. We don't have the View report. we will just need to add the new screenshot for v2.4 and remove the 3 that are there and re-word. I could do this if needed?? @andrewazores

[andrewazores]

Ah right, good catch, that is correct. You can take that on if you'd like, but please do separate out the work into 1. updating the written content (can be done in this PR or separately as I have been doing) and 2. updating the screenshot, targeted onto the #147 branch.