|
| 1 | +# Maintenance: OCI UI Update 2025 |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +As part of a major UI update, it’s essential to review and update workshops to ensure accuracy. This guide walks you through the process of making changes in GitHub using a feature branch. |
| 6 | + |
| 7 | +By following these steps, you will: |
| 8 | +- Check if the content is still relevant and up to date. |
| 9 | +- Verify if any workflows have changed. |
| 10 | +- Determine whether screenshots need updating. |
| 11 | + |
| 12 | +Using a feature branch allows for a structured and controlled way to make updates without affecting the main branch until the changes are reviewed and approved. |
| 13 | + |
| 14 | +### Objectives |
| 15 | + |
| 16 | +By the end of this guide, you will be able to: |
| 17 | + |
| 18 | +* **Fork and clone a repository** using GitHub UI and GitHub Desktop. |
| 19 | +* **Sync with upstream updates** to ensure you are working with the latest version (GitHub Desktop). |
| 20 | +* **Make changes using VS Code**, including updating content and modifying screenshots if needed. |
| 21 | +* **Push changes** to your feature branch. |
| 22 | +* **Open a pull request** using GitHub Desktop and GitHub UI, ensuring the correct branch is selected for review. |
| 23 | + |
| 24 | +These steps will help you update your workshop effectively while maintaining version control best practices. |
| 25 | + |
| 26 | + |
| 27 | +## Task 1: Fork and clone repository (GitHub UI + GitHub Desktop) |
| 28 | + |
| 29 | +To begin making changes, you need to **fork** the repository. This creates a personal copy of the repository under your GitHub account, allowing you to make updates without affecting the original project. |
| 30 | + |
| 31 | +Follow the steps in the official documentation to fork and clone the repository: |
| 32 | +[How to Fork a Repository](https://oracle-livelabs.github.io/common/sample-livelabs-templates/create-labs/labs/workshops/livelabs/?lab=3-labs-sync-github) |
| 33 | + |
| 34 | +> 📌 **Note:** If you have already completed this step, continue to **Task 2**. |
| 35 | +
|
| 36 | +## Task 2: Sync with Upstream Updates (GitHub Desktop) |
| 37 | + |
| 38 | +To ensure you're working with the latest version of the repository, you need to sync your fork with the upstream repository. This helps prevent merge conflicts before final integration. |
| 39 | + |
| 40 | +### Steps to Sync: |
| 41 | +1. Open **GitHub Desktop**. |
| 42 | +2. Click **Fetch Origin** to check for updates. |
| 43 | +3. Go to **Branch > Merge into Current Branch**. |
| 44 | +4. Select **main** to pull the latest changes from the upstream repository. |
| 45 | +5. Click **Push Origin** to update your fork with the latest changes. |
| 46 | + |
| 47 | +> 📌 **Note:** **Keeping your fork up to date helps avoid merge conflicts later.** |
| 48 | +
|
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +Once your fork is up to date, continue to **Task 3**. |
| 54 | + |
| 55 | +## Task 3: Make Changes Using VS Code |
| 56 | + |
| 57 | +Once your repository is up to date, you can start making edits using **VS Code**. |
| 58 | + |
| 59 | +### Steps to Edit Content: |
| 60 | + |
| 61 | +1. Open **VS Code**. |
| 62 | +2. Select **File > Open Folder**, then choose the cloned repository. |
| 63 | +3. Make edits to the workshop content as needed. |
| 64 | +4. Open the **Source Control Panel** (`Ctrl+Shift+G`) to review your changes. |
| 65 | +5. Save your changes. |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +Once your edits are complete, continue to **Task 4**. |
| 70 | + |
| 71 | +## Task 4: Pushing Changes (GitHub Desktop) |
| 72 | + |
| 73 | +After making edits in VS Code, you need to **commit and push** your changes to your feature branch in GitHub. |
| 74 | + |
| 75 | +### Steps to Push Changes: |
| 76 | + |
| 77 | +1. Open **GitHub Desktop**. |
| 78 | +2. Review the list of changes in the **Changes** tab. |
| 79 | +3. Add a commit message describing your updates. |
| 80 | +4. Click **Commit to main** to save the changes locally. |
| 81 | +5. Click **Push Origin** to upload the changes to your GitHub repository. |
| 82 | + |
| 83 | +📌 **This step ensures your updates are stored in your GitHub fork.** |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +Once your changes are pushed, proceed to **Task 5**. |
| 90 | + |
| 91 | +## Task 5: Open a Pull Request (GitHub Desktop + GitHub UI) |
| 92 | + |
| 93 | +After pushing your changes, you need to open a **Pull Request (PR)** to submit your updates for review. |
| 94 | + |
| 95 | +### Steps to Open a Pull Request: |
| 96 | + |
| 97 | +1. Go to **GitHub** and navigate to **Your Fork**. |
| 98 | +2. Click on **Pull Requests** > **New Pull Request**. |
| 99 | +3. Set the following branch details: |
| 100 | + - **Base Branch:** `ui-update-2025` (from the base repository). |
| 101 | + - **Compare Branch:** `main` (from your forked repository). |
| 102 | +4. Add a title using the following format: |
| 103 | + - `Workshop###<your workshop> + OCI-UI-UPDATE-2025` |
| 104 | + > Replace `###<your workshop>` with the actual workshop number and title you are updating. |
| 105 | +5. Fill in the **description** field with relevant details about your changes. |
| 106 | +6. Click **Create Pull Request** to allow review (this prevents merging until approved). |
| 107 | +7. If any merge conflicts appear, resolve them before proceeding. |
| 108 | +8. Once everything is approved, click **Merge Pull Request**. |
| 109 | + |
| 110 | +> For a visual reference, see: |
| 111 | +
|
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | + |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | +> 📌 **Note:** **This process ensures content is reviewed progressively while avoiding premature merges.** |
| 129 | +
|
| 130 | +With this step completed, your changes are now submitted for review! 🚀 |
| 131 | + |
| 132 | + |
| 133 | +## Acknowledgements |
| 134 | +* **Author:** |
| 135 | + * Matt Kowalik, Senior Product Manager, Oracle Database Product Management |
| 136 | +* **Contributors:** |
| 137 | + * Hope Fisher, Product Manager, Oracle Database Product Management |
| 138 | + * Ramona Magadan, Technical Program Manager, Oracle Database Product Management |
| 139 | + |
| 140 | +* **Reviewed by:** |
| 141 | + * Kevin Lazarz, Senior Manager, Product Management, Oracle Database Product Management |
| 142 | + |
| 143 | +* **Last Updated By/Date:** |
| 144 | + * Matt Kowalik, Senior Product Manager, Oracle Database Product Management, March 2025 |
0 commit comments