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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 36 commits into from
Dec 11, 2023
Merged

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

merged 36 commits into from
Dec 11, 2023

Conversation

aali309
Copy link
Contributor

@aali309 aali309 commented Nov 9, 2023

fixes: #120

@aali309 aali309 added the chore Refactor, rename, cleanup, etc. label Nov 9, 2023
@aali309 aali309 force-pushed the formatGuidesSubsectionsNavigateTheDashboard branch 3 times, most recently from f511f04 to 9b8ca28 Compare November 15, 2023 16:58
@aali309 aali309 marked this pull request as ready for review November 15, 2023 20:14
@mwangggg
Copy link
Member

mwangggg commented Nov 15, 2023 •
edited
Loading

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
Copy link
Member

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"

@aali309 aali309 force-pushed the formatGuidesSubsectionsNavigateTheDashboard branch from bed2af3 to ec17421 Compare November 16, 2023 16:49
@mwangggg
Copy link
Member

mwangggg commented Nov 16, 2023 •
edited
Loading

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
Copy link
Contributor Author

aali309 commented Nov 16, 2023

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
Copy link
Contributor Author

aali309 commented Nov 16, 2023 •
edited
Loading

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
Copy link
Member

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 andrewazores force-pushed the 143-story-update-written-content-for-240 branch from 2f69532 to 316e3d4 Compare November 16, 2023 17:38
@andrewazores
Copy link
Member

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).

@andrewazores andrewazores mentioned this pull request Nov 16, 2023
Merged
10 tasks
@andrewazores andrewazores merged commit 8e2fa3d into cryostatio:143-story-update-written-content-for-240 Dec 11, 2023
2 checks passed
andrewazores added a commit that referenced this pull request Dec 11, 2023
@andrewazores @aali309
chore(release): update written content (#148)
f4773eb 
* chore(get-started): update screenshots (#145)

* chore(get-started): extract Cryostat Agent version property, update (#146)

* chore(get-started): formatting of terms and phrases (#150)

Signed-off-by: Atif Ali <56743004+aali309@users.noreply.github.com>

* chore(guides): formatting of terms and phrases in guides-index.md (#152)

* chore(agent): update Cryostat Agent content (#155)

* chore(guides): update Automated Analysis guide (#158)

* chore(credentials): update guides around stored credentials (#159)

* chore(credentials): correct a formatting error (#160)

* chore(snapshot): update snapshot content (#161)

* chore(custom_target): update custom target content (#163)

* chore(doc): document using Smart Triggers (#169)

* using smart triggers

* using smart triggers completed

* consistency

* resolved issues

* resolved more issues

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

* formatting of terms and phrases

* commited to start use topology view

* custome target updated

* commited to start on event templates

* commited to start on event templates(edit template with JMC)

* commited to start view and download automated Analysis for a recording

* done (first commit)

* updated Add and Edit Recording Metadata Labels

* updated Add and Edit Recording Metadata Labels

* updated archive a recording section

* started updating automated analysis

* automated analysis needs updating

* custome target updated

* updated download-an-active-or-archived-recording.md

* updated Re-Upload a Recording to Archives

* updated screenshots to the right folders

* updated written content to mathc updated screenshots on automated analysis

* configure Graphical Notifications

* configure credentials storage updated

* more updates on store credentials and create an automated rule

* review changes before start topologyview

* reviewed use Topology view

* reviewed create a custom target

* reviewed using the cryostat agent

* reviewed start/stop a recording

* reviewed snapshot a recording

* reviewed archives and related docs

* reviewed event templates and related docs && removed format on clickable links

* reviewed view in grafana

* resolved some comments

* removed download the report in automated-analysis.md

* configure credentials storage reviewed

* create an automated rule updated

* add-and-edit-recording-metadata-labels.md updated

* store credentials reviewed

* upload and download automated rule reviewed

* fixup! Merge remote-tracking branch 'upstream/prepare-240-release' into 143-story-update-written-content-for-240

---------

Signed-off-by: Atif Ali <56743004+aali309@users.noreply.github.com>
Co-authored-by: Atif Ali <56743004+aali309@users.noreply.github.com>
@aali309 aali309 deleted the formatGuidesSubsectionsNavigateTheDashboard branch December 11, 2023 20:21
@aali309 aali309 mentioned this pull request May 30, 2024
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mwangggg mwangggg mwangggg left review comments

@andrewazores andrewazores Awaiting requested review from andrewazores

Assignees
No one assigned
Labels
chore Refactor, rename, cleanup, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aali309 @mwangggg @andrewazores