chore(get-started): formatting of terms and phrases #150
Conversation
|
@andrewazores @ebaron please take a look at this and let me know. I checked some other community guides for documentation, this looks so different. i will try to look pattern-fly guide or something from Red Hat |
|
Which other guides did you look at for comparison? In any case, this is the documentation for the upstream project, so while it would perhaps be nice to have a similar look and feel to other Red Hat-sponsored projects, I don't think it's a requirement. If we do want to go that way it would be a larger change and something to look at in the longer term. |
I looked at OpenShift and GutHub. I agree it is a larger change. What do you think of the changes? Should I continue this way? I followed @tthvo comments on the issue |
|
Yes I think what you're doing here is a good improvement to the existing docs as they are. I don't see any particular need to change anything on a larger scale, certainly not in the timeframe for this upcoming 2.4 release. If you'd like, for the goal of keeping the review loop shorter and easier, we can just retarget this PR from going into |
aali309
changed the base branch from
main
to
143-story-update-written-content-for-240
andrewazores
changed the title
aali309
force-pushed
the
consistentFormating
branch
from
a10b690
to
4060cb3
Compare
aali309
force-pushed
the
consistentFormating
branch
from
a77a15e
to
8eb2019
Compare
aali309
force-pushed
the
consistentFormating
branch
from
dce49fd
to
74cd663
Compare
aali309
force-pushed
the
consistentFormating
branch
from
a705605
to
7b8e636
Compare
|
@aali309 if you could please wrap up the last couple of review comments here, I'd like to get this merged so I can work on top of it and update the written content for the Agent without making your rebase super annoying |
aali309
force-pushed
the
consistentFormating
branch
from
185c7fb
to
5baa68b
Compare
…ntFormating Signed-off-by: Atif Ali <56743004+aali309@users.noreply.github.com>
andrewazores
merged commit 72d6aed
into
cryostatio:143-story-update-written-content-for-240
Signed-off-by: Atif Ali <56743004+aali309@users.noreply.github.com>
* 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>
fixes: #120