Perform quarterly qa: WMS ID 11725 (#289)

perform quarterly qa
oracle-livelabs · Jul 26, 2024 · ed42523 · ed42523
1 parent 4954dd6
commit ed42523
Show file tree

Hide file tree

Showing 17 changed files with 160 additions and 0 deletions.
diff --git a/labs/how-to-quarterly-qa/livelabs/index.html b/labs/how-to-quarterly-qa/livelabs/index.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="description" content="Oracle LiveLabs gives you access to Oracle's products to run a wide variety of labs and workshops; allowing you to experience our best technology, live!">
+    <title>Oracle LiveLabs</title>
+
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/jquery-1.11.0.min.js"></script>
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/jquery-ui-1.10.4.custom.js"></script>
+    <script src="https://oracle-livelabs.github.io/common/redwood-hol/js/main.min.js"></script>
+
+    <link rel="stylesheet" href="https://oracle-livelabs.github.io/common/redwood-hol/css/style.min.css" />
+    <link rel="shortcut icon" href="https://oracle-livelabs.github.io/common/redwood-hol/img/favicon.ico" />
+</head>
+
+<body>
+    <header class="hol-Header" role="banner">
+        <div class="hol-Header-wrap">
+            <div class="hol-Header-logo"><span>Oracle LiveLabs</span></div>
+            <a href="https://oracle.com/livelabs" target="_blank" id="livelabs" title="Oracle LiveLabs"></a>
+            <div class="hol-Header-actions">
+                <button id="openNav" class="hol-Header-button hol-Header-button--menu rightNav" aria-label="Open Menu"
+                    title="Open Menu">
+                    <span class="hol-Header-toggleIcon"></span>
+                </button>
+            </div>
+        </div>
+    </header>
+
+    <div id="container">
+        <div id="leftNav">
+            <div id="toc"></div>
+        </div>
+        <div id="contentBox">
+            <main class="hol-Content" id="module-content"></main>
+        </div>
+    </div>
+
+      <footer class="hol-Footer">
+        <a class="hol-Footer-topLink" href="#top">Return to Top</a>
+        <div id="footer-banner"><div class="footer-row">
+          <div class="footer-content"><ul class="footer-links">
+              <li><a href="https://docs.oracle.com/pls/topic/lookup?ctx=en/legal&id=cpyr" target="_blank" aria-label="Open a new window to Oracle legal notices" data-lbl="copyright">© Oracle</a></li>
+              <li><a href="https://www.oracle.com/corporate/index.html" target="_blank" aria-label="Open a new window to learn more about oracle" data-lbl="about-oracle">About Oracle</a></li>
+              <li><a href="https://www.oracle.com/corporate/contact/" target="_blank" aria-label="Open a new window to contact oracle" data-lbl="contact-us">Contact Us</a></li>
+              <li class="footer-links-break"></li>
+              <li><a href="https://docs.oracle.com/en/browseall.html" target="_blank" aria-label="Open a new window to products a-z" data-lbl="products-a-z">Products A-Z</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/" target="_blank" aria-label="Open a new window to read more about Oracle terms of use and privacy" data-lbl="terms-of-use-and-privacy">Terms of Use & Privacy</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/privacy-policy.html#11" target="_blank" aria-label="Open a new window to read more about managing Oracle cookie preferences" data-lbl="cookie-preferences">Cookie Preferences</a></li>
+              <li><a href="https://www.oracle.com/legal/privacy/marketing-cloud-data-cloud-privacy-policy.html#adchoices" target="_blank" aria-label="Open a new window to ad choices" data-lbl="ad-choices">Ad Choices</a></li>
+              <li class="footer-links-break"></li><li class="last"><a href="https://docs.oracle.com/pls/topic/lookup?ctx=en/legal&id=cpyr" target="_blank" aria-label="Open a new window to Oracle legal notices" data-lbl="copyright">© Oracle</a></li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </footer>
+</body>
+
+</html>
diff --git a/labs/how-to-quarterly-qa/livelabs/manifest.json b/labs/how-to-quarterly-qa/livelabs/manifest.json
@@ -0,0 +1,11 @@
+{
+  "workshoptitle": "New Workshop Step by Step",
+  "help": "livelabs-help-db_us@oracle.com",
+	"tutorials": [
+    {
+      "title": "Quarterly QA checks and steps",
+      "description": "This lab prepares you for performing Quarterly QA of your workshop, details to look for and adjust before updating your workshop.",
+      "filename": "./../qa-checks/qa-checks.md"
+    }
+  ]
+}
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/complete-checklist-warning.png b/labs/how-to-quarterly-qa/qa-checks/images/complete-checklist-warning.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/completed-checklist-1.png b/labs/how-to-quarterly-qa/qa-checks/images/completed-checklist-1.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/completed-checklist-2.png b/labs/how-to-quarterly-qa/qa-checks/images/completed-checklist-2.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/confirm-push-to-ll.png b/labs/how-to-quarterly-qa/qa-checks/images/confirm-push-to-ll.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/disabled.png b/labs/how-to-quarterly-qa/qa-checks/images/disabled.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/entry-disabled.png b/labs/how-to-quarterly-qa/qa-checks/images/entry-disabled.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/last-qa-details-populated.png b/labs/how-to-quarterly-qa/qa-checks/images/last-qa-details-populated.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/qqa-schema.png b/labs/how-to-quarterly-qa/qa-checks/images/qqa-schema.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa-complete-confirmation.png b/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa-complete-confirmation.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa-complete.png b/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa-complete.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa.png b/labs/how-to-quarterly-qa/qa-checks/images/quarterly-qa.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/self-qa-checklist-1.png b/labs/how-to-quarterly-qa/qa-checks/images/self-qa-checklist-1.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/self-qa-checklist-2.png b/labs/how-to-quarterly-qa/qa-checks/images/self-qa-checklist-2.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/images/stakeholder.png b/labs/how-to-quarterly-qa/qa-checks/images/stakeholder.png
diff --git a/labs/how-to-quarterly-qa/qa-checks/qa-checks.md b/labs/how-to-quarterly-qa/qa-checks/qa-checks.md
@@ -0,0 +1,87 @@
+# How to perform Quarterly QA for your workshop
+
+## Introduction
+
+This sprint will help to perform Quarterly QA for your workshop. It will walk you through all of the steps. Quality checks and reviews of your workshop ensure the users enjoy the workshops and provide the best experience with Oracle technologies. Some of the QA steps ensure the LiveLabs standards, and hopefully, most of these checks have been done throughout the workshop's development.
+
+### Duration: 15 min
+
+### Objectives
+
+* Tested and verified workshop content for accuracy and completeness
+
+### What Do You Need?
+
+* Git Environment Setup
+* GitHub Desktop client
+
+Check the following schema to see how to self-QA your workshop.
+![Quarterly QA schema](images/qqa-schema.png " ")
+
+
+## Perform Quarterly QA
+
+For the workshop in Completed or Quarterly QA Complete status and have Published - Public or Published - Event entries, we want to ensure that customers benefit from workshops that contain up-to-date information. So, the workshop team needs to perform Quarterly QA of the workshop every 90 days.
+
+> **Note:** Maintaining several workshops and running through the QA can be time consuming. We are suggesting a two-phased approach to make sure critical items are addressed regularly.
+  - **Lite QA:** Review the workshop on a high level for screenshots, links, and instructions to ensure the workshop is current and is using the latest version. Make any minor changes, if necessary, to keep the content updated.
+  - **In-depth QA:** Run through the workshop end-to-end to ensure it is working as expected since it was published. Update workshop if necessary
+  - **Example:** If there are ten workshops to QA, in the first quarter, you can perform lite QA reviews for the first 1-5 (or a selection) workshops and in-depth QA for the following 5-10 workshops. Subsequently, in the following quarter, you can perform in-depth QA for the first 1-5 workshops and lite QA for the following 5-10 workshops. This approach will allow you to manage more workshops while ensuring thorough quality assessment efficiently.
+
+1. The workshop status will automatically update to Quarterly QA after 90 days from the time you have last performed QA of your workshop. When the status is updated to Quarterly QA, the workshop team will receive an email with instructions to perform Quarterly QA of the workshop.
+
+    ![Quarterly QA](images/quarterly-qa.png " ")
+
+2. At this point, the workshop team will have 10 days to perform the Quarterly QA of the workshop.
+
+3.  If you have changed your Status to **Self QA** or your workshop status is in **Quarterly QA**, click on the **Self QA Checklist** tab and check your workshop against the form. Update your workshop and create a new pull request if necessary for the workshop to follow LiveLabs standards.
+
+  ![Self QA Checklist](./images/self-qa-checklist-1.png " ")
+  ![Self QA Checklist](./images/self-qa-checklist-2.png " ")
+
+4. You *MUST* check all the boxes on the Self QA Checklist form, upload the images and update the pull request link if you created one (optional).
+
+5. Click **Save** and confirm **Push to LiveLabs** to save your checklist changes before you update your workshop status to Quarterly QA Complete.
+
+  ![Confirm Push to LiveLabs](images/confirm-push-to-ll.png " ")
+
+  Otherwise, you will get this warning while updating your workshop status to Quarterly QA Complete and you will not be able to save your workshop status to Quarterly QA Complete.
+
+  ![Complete checklist warning](./images/complete-checklist-warning.png " " )
+
+6. After saving the checklist changes, then set your **Workshop Status** to **Quarterly QA Complete**.
+
+  ![Quarterly QA Complete](images/quarterly-qa-complete.png " ")
+
+7. Confirm you have performed Quarterly QA by clicking **Yes, I certify**.
+
+  ![Quarterly QA complete confirmation](./images/quarterly-qa-complete-confirmation.png " ")
+
+8. Click **Save** button and then click **Push to LiveLabs**. Now, you have updated your workshop status to Quarter QA Complete and have completed the QA of the workshop.
+
+  ![Confirm Push to LiveLabs](images/confirm-push-to-ll.png " ")
+
+  After saving your workshop status to Quarterly QA Complete, you Self QA Checklist tab will grey out with the QA History section populated in the checklist tab and last QA date and person email updated on the workshop details tab.
+
+  ![Completed Checklist](./images/completed-checklist-1.png " ")
+  ![Completed Checklist](./images/completed-checklist-2.png " ")
+  ![Last QA details populated](./images/last-qa-details-populated.png " ")
+
+9. If the workshop team does not perform the Quarter QA within the given time period, the LiveLabs publishers will disable the workshop in WMS i.e the published entry of the workshop will be pulled off from production. This is a disable, not a delete. So, your workshop will remain in the WMS catalog and you can bring back to production after completing the Quarterly QA of the workshop.
+
+  ![Entry Disabled](./images/entry-disabled.png " ")
+  ![Disabled](./images/disabled.png " ")
+
+10. Questions? Go to your workshop and find your stakeholder email address, and contact them. You can also ask in the #workshops-authors-help Slack channel.
+
+  ![Stakeholder](images/stakeholder.png " ")
+
+## Acknowledgements
+
+* **Author:**
+   * Michelle Malcher, Director, Oracle Database Product Management
+* **Contributors:**
+    * Magadan Ramona, Technical Program Manager, Oracle Database Product Management, July 2024
+
+* **Last Updated By/Date:**
+    * Magadan Ramona, Technical Program Manager, Oracle Database Product Management, July 2024