chore(release): update written content (#148)

* 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>
cryostatio · Dec 11, 2023 · f4773eb · f4773eb
1 parent c4546af
commit f4773eb
Show file tree

Hide file tree

Showing 34 changed files with 826 additions and 819 deletions.
diff --git a/_data/versions.yaml b/_data/versions.yaml
@@ -1,6 +1,8 @@
 cryostat:
-  version: 2.4.0
-  release-branch: cryostat-v2.4
+  version: '2.4.0'
+  release-branch: 'cryostat-v2.4'
+agent:
+  version: '0.3.0'
 openshift:
   version: '4.10'
 kubernetes:

diff --git a/get-started/index.md b/get-started/index.md
diff --git a/guides/_subsections/add-a-trusted-certificate.md b/guides/_subsections/add-a-trusted-certificate.md
@@ -1,12 +1,12 @@
 ## [Add a Trusted Certificate](#add-a-trusted-certificate)
-If you have Java Management Extensions (JMX) over SSL enabled on your containerized JVMs, you must configure Cryostat to trust the SSL certificate presented by the containerized JVM when Cryostat attempts to open a JMX connection. If you do not complete this configuration, Cryostat cannot open a JMX connection for the purposes of performing JFR management tasks.
+If you have Java Management Extensions **(JMX)** over `SSL` enabled on your containerized **JVMs**, you must configure **Cryostat** to trust the `SSL` certificate presented by the containerized **JVM** when **Cryostat** attempts to open a **JMX** connection. If you do not complete this configuration, **Cryostat** cannot open a **JMX** connection for the purposes of performing **JFR** management tasks.
 
-Here's how to add a trusted SSL certificate with the Cryostat web UI.
+Here's how to add a trusted `SSL` certificate with the **Cryostat Web** UI.
 
 <ol>
     <li>
         {% include howto_step.html
-          summary="Navigate to the Security tab"
+          summary="Navigate to the <i>Security</i> Tab"
           image-name="2.4.0/navigate-to-security.png"
           text="Click the <i>Security</i> tab."
         %}
@@ -16,23 +16,23 @@ Here's how to add a trusted SSL certificate with the Cryostat web UI.
           summary="Upload the Certificate"
           image-name="2.4.0/add-a-trusted-certificate-upload.png"
           text="
-              Click the <i>Upload</i> button on the <i>Import SSL Certificates</i> card. This action opens a file-upload dialog, where you can choose the certificate that you want to upload to Cryostat. You can repeat this process multiple times to add multiple trusted certificates.
+              Click the <i>Upload</i> button on the <i>Import SSL Certificates</i> card. This action opens a file-upload dialog, where you can choose the certificate that you want to upload to <b>Cryostat</b>. You can repeat this process multiple times to add multiple trusted certificates.
           "
         %}
     </li>
     <li>
-        Restart Cryostat to apply the changes. If you do not restart your Cryostat instance, the added certificates are not reloaded. This causes connections to fail because the Cryostat JMX client cannot trust the certificates. Depending on your deployment platform and configuration, restarting Cryostat might require any of the following:
+        Restart <b>Cryostat</b> to apply the changes. If you do not restart your <b>Cryostat</b> instance, the added certificates are not reloaded. This causes connections to fail because the <b>Cryostat JMX</b> client cannot trust the certificates. Depending on your deployment platform and configuration, restarting <b>Cryostat</b> might require any of the following:
         <ul>
             <li>
-                On OpenShift/Kubernetes with Cryostat Operator:
+                On <b>OpenShift/Kubernetes</b> with <b>Cryostat Operator</b>:
                 <pre>oc delete cryostat/&lt;my-cryostat-cr-name&gt;<br>oc create -f &lt;my-cryostat-cr-name&gt;.yaml</pre>
             </li>
             <li>
-                On OpenShift/Kubernetes without Cryostat Operator:
+                On <b>OpenShift/Kubernetes</b> without <b>Cryostat Operator</b>:
                 <pre>oc rollout retry dc/&lt;my-cryostat-dc-name&gt;</pre>
             </li>
             <li>
-                On Podman:
+                On <b>Podman</b>:
                 <pre>podman restart &lt;my-cryostat-container-id&gt;</pre>
             </li>
         </ul>

diff --git a/guides/_subsections/add-and-edit-recording-metadata-labels.md b/guides/_subsections/add-and-edit-recording-metadata-labels.md
@@ -1,5 +1,5 @@
 ## [Add and Edit Recording Metadata Labels](#add-and-edit-recording-metadata-labels)
-Users can attach metadata or custom labels to JDK flight recordings managed by Cryostat. Recording labels can be used to identify recordings during queries or perform actions on multiple recordings containing the same labels. Here’s how to add and edit metadata labels on your JDK flight recordings.
+Users can attach `Metadata` or `Custom Labels` to **JDK** `Flight Recordings` managed by **Cryostat**. `Recording Labels` can be used to identify `Recordings` during queries or perform actions on multiple `Recordings` containing the same `Labels`. Here’s how to *Add* and *Edit* `Metadata Labels` on your **JDK** `Flight Recordings`.
 
 <ol>
   <li>
@@ -10,72 +10,72 @@ Users can attach metadata or custom labels to JDK flight recordings managed by C
   </li>
   <li>
     {% include howto_step.html
-      summary="Add metadata labels to the Create Recording form"
+      summary="Add <code>Metadata Labels</code> to the <i>Create Recording</i> form"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-1.png"
       text="
-        When creating a custom flight recording with Cryostat, expand the form section <i>Show metadata options</i>. Click <i>Add Label</i> and add key-value label pairs to the form. Finally, click <i>Create</i> to attach the labels and create the recording.
+        When creating a custom <code>Flight Recording</code> with <b>Cryostat</b>, expand the form section <i>Show metadata options</i>. Click <i>Add Label</i> and add <i>key-Value</i> <code>Label</code> pairs to the form. Finally, click <i>Create</i> to attach the <code>Labels</code> and create the <code>Recording</code>.
       "
     %}
   </li>
   <li>
     {% include howto_step.html
-      summary="View your labels on the Active Recordings Table"
+      summary="View your <code>Labels</code> on the <i>Active Recordings</i> Table"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-2.png"
       text="
-        The new recording will appear in the Recordings tab with your custom label as well as default labels containing information about the selected recording template.
+        The new <code>Recording</code> will appear in the <i>Recordings Tab</i> with your <code>Custom Label</code> as well as default <code>Labels</code> containing information about the selected <code>Recording</code> template.
       "
     %}
   </li>
   <li>
     {% capture edit-an-existing-label-text %}
     <p>
-      Recording labels can also be edited after recordings have been created or re-uploaded to archives. It looks like the custom label in our example contains a typo - we can fix the typo by editing the label. First select a recording from the table with the 🗹 checkbox. Then, click the <i>Edit Labels</i> button to bring up the label drawer. Finally, click the <i>Edit</i> button that appears from the drawer.
+      <code>Recording Labels</code> can also be edited after <code>Recordings</code> have been created or re-uploaded to archives. It looks like the <code>Custom Label</code> in our example contains a typo - we can fix the typo by editing the <code>Label</code>. First select a <code>Recording</code> from the table with the 🗹 checkbox. Then, click the <i>Edit Labels</i> button to bring up the label drawer. Finally, click the <i>Edit</i> button that appears from the drawer.
       <br><br>
       <a href="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-4.png" target="_blank">
         <img src="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-4.png">
       </a>
       <br><br>
-      The labels section will appear as a form where you can add, edit, or delete existing labels, just like before when we created the recording. Fix the typo, and click <i>Save</i> to save your edited labels.
+      The <code>Labels</code> section will appear as a form where you can <i>Add</i>, <i>Edit</i>, or <i>Delete</i> existing <code>Labels</code>, just like before when we created the <code>Recording</code>. Fix the typo, and click <i>Save</i> to save your edited <code>Labels</code>.
     </p>
     {% endcapture %}
     {% include howto_step.html
-      summary="Edit an existing label"
+      summary="Edit an Existing <code>Label</code>"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-3.png"
       text=edit-an-existing-label-text
     %}
   </li>
   <li>
     {% include howto_step.html
-      summary="View your edited labels"
+      summary="View your edited <code>Labels</code>"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-5.png"
       text="
-        The recording labels should be updated in the Active Recordings table. 
+        The <code>Recording Labels</code> should be updated in the <i>Active Recordings</i> table.
       "
     %}
   </li>
   <li>
     {% include howto_step.html
-      summary="<i>(Optional)</i> Archive your recording to view labels copied onto the archived recording"
+      summary="<i>(Optional)</i> Archive your <code>Recording</code> to view <code>Labels</code> copied onto the <code>Archived Recording</code>"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-6.png"
       text="
-        On the Active Recordings table, click the checkbox next to the recording, then click <i>Archive</i> to archive your recording. Notice that the archived recording also copies the labels from the active recording. You can also add labels to any recording uploaded to Cryostat’s archives.
+        On the <i>Active Recordings</i> table, click the <i>Checkbox</i> next to the <code>Recording</code>, then click <i>Archive</i> to archive your <code>Recording</code>. Notice that the <code>Archived Recording</code> also copies the <code>Labels</code> from the <code>Active Recording</code>. You can also add <code>Labels</code> to any <code>Recording</code> uploaded to <b>Cryostat’s</b> archives.
       "
     %}
   </li>
   <li>
     {% capture bulk-edit-recording-labels-text %}
     <p>
-      Create another recording on the same target. Then select both recordings on the Recordings Table and click <i>Edit Labels</i> and <i>Edit</i>.This time, only labels that are present on both recordings will be shown in the form. Let's delete the two common template-related labels, and add a new label to both recordings. Then finally, click <i>Save</i>.
+      Create another <code>Recording</code> on the same target. Then select both <code>Recordings</code> on the <i>Recordings Table</i> and click <i>Edit Labels</i> and start editing. This time, only <code>Labels</code> that are present on both <code>Recordings</code> will be shown in the form. Let's <i>Delete</i> the two common template-related <code>Labels</code>, and <i>Add</i> a new <code>Label</code> to both <code>Recordings</code>. Then finally, click <i>Save</i>.
       <br><br>
       <a href="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-8.png" target="_blank">
         <img src="{{ site.url }}/images/2.4.0/add-and-edit-recording-metadata-labels-8.png">
       </a>
       <br><br>
-      Congratulations, you have successfully bulk-edited labels across multiple recordings!
+      Congratulations, you have successfully bulk-edited <code>Labels</code> across multiple <code>Recordings</code>!
     </p>
     {% endcapture %}
     {% include howto_step.html
-      summary="<i>(Optional)</i> Bulk-edit recording labels across multiple recordings"
+      summary="<i>(Optional)</i> Bulk-edit <code>Recording Labels</code> across multiple <code>Recordings</code>"
       image-name="2.4.0/add-and-edit-recording-metadata-labels-7.png"
       text=bulk-edit-recording-labels-text
     %}

diff --git a/guides/_subsections/archive-a-recording.md b/guides/_subsections/archive-a-recording.md
@@ -1,15 +1,15 @@
 ## [Archive a Recording](#archive-a-recording)
-In contrast to <i>Active Recordings</i>, which reside within the container
-of the target application, <i>Archived Recordings</i> reside within persistent
-storage attached to a Cryostat instance. In OpenShift, for example, the
+In contrast to `Active Recordings`, which reside within the container
+of the `target` application, `Archived Recordings` reside within persistent
+storage attached to a **Cryostat** instance. In **OpenShift**, for example, the
 archives are stored in a `PersistentVolumeClaim`.
 
-Archived recordings are created by performing archival upon active recordings.
-When this is requested, Cryostat connects to the target application and copies
-the Flight Recorder data from the selected active recording into an archived
-recording file in storage. The active source recording may be continuous or
-fixed-duration, may be using any event template, may be in
-any state (`RUNNING`, `STOPPED`, etc.), and may even be a snapshot.
+`Archived Recordings` are created by performing archival upon `Active Recordings`.
+When this is requested, **Cryostat** connects to the `target` application and copies
+the `Flight Recorder` data from the selected `Active Recording` into an `Archived
+Recording` file in storage. The `Active Source Recording` may be `Continuous` or
+`Fixed-duration`, using any *Event Template*, in
+any state (`RUNNING`, `STOPPED`, etc.), and may even be a `snapshot`.
 
 <ol>
   <li>
@@ -21,14 +21,14 @@ any state (`RUNNING`, `STOPPED`, etc.), and may even be a snapshot.
   <li>
     {% capture select-recording-additional-content %}
       <p>
-        If you do not have any recordings present in the Active Recordings
+        If you do not have any <code>Recordings</code> present in the <i>Active Recordings</i>
         view, follow
         <a href="{{ page.url }}#startstop-a-recording">Start/Stop a Recording</a>
-        to create one, or select a different target application.
+        to create one, or select a different <code>target</code> application.
       </p>
     {% endcapture %}
     {% include howto_step.html
-      summary="Select an Active Recording"
+      summary="Select an <i>Active Recording</i>"
       image-name="2.4.0/archive-a-recording-1.png"
       caption=select-recording-additional-content
     %}
@@ -41,14 +41,14 @@ any state (`RUNNING`, `STOPPED`, etc.), and may even be a snapshot.
       summary="Navigate to the <i>Archived Recordings</i> tab"
       image-name="2.4.0/archive-a-recording-2.png"
       caption="
-        Once the recording has been archived, a new entry will appear in the
-        target JVM's <i>Archived Recordings</i> table. All recordings that were
-        saved from the current target will be listed here in their own table.
-        Switching to a different target from the dropdown will list only the 
-        recordings archived from that source target. The name of the archived 
-        recording reflects the address of the target application, the original 
-        name of the active recording that it was retrieved from, and includes a 
-        timestamp indicating when the archived recording was created.
+        Once the <code>Recording</code> has been archived, a new entry will appear in the
+        <code>target</code> <b>JVM's</b> <i>Archived Recordings</i> table. All <code>Recordings</code> that were
+        saved from the current <code>target</code> will be listed here in their own table.
+        Switching to a different <code>target</code> from the dropdown will list only the
+        <code>Recordings</code> archived from that source <code>target</code>. The name of the <code>Archived
+        Recording</code> reflects the address of the <code>target</code> application, the original
+        name of the <code>Active Recording</code> that it was retrieved from, and includes a
+        <code>timestamp</code> indicating when the <code>Archived Recording</code> was created.
       "
     %}
   </li>