Skip to content

Commit c056cf3

Browse files
authored
Updated step-by-step with green button instructions (#185)
* Updated Quarterly QA process * Added connectivity issue and Groups steps * updated * Added steps to new re-publsih requested process * Updated step-by-step
1 parent 81d2127 commit c056cf3

16 files changed

+88
-20
lines changed

sample-livelabs-templates/create-labs/labs/3-labs-sync-github/3-labs-sync-github.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ When you create, delete, or modify assets in your clone (local copy), you should
164164
165165
To commit your changes:
166166
1. Start your **GitHub Desktop** client.
167+
167168
2. In the **Summary (required)** text box on the left (next to your picture), enter a summary of your changes. You can optionally add a more detailed description of your changes in the **Description** text box.
168169

169170
![Enter a summary of your changes.](./images/git-hub-commit-to-main.png " ")
@@ -172,7 +173,7 @@ To commit your changes:
172173

173174
4. Click **Push origin** (it should have an upward arrow with a number). This pushes the updated content from your clone into the origin of this clone, that is, your fork.
174175

175-
![Push updated content to the origin.](./images/git-hub-commit-push-origin.png " ")
176+
![Push updated content to the origin.](./images/push-origin.png " ")
176177

177178
## Task 7: Set up GitHub pages for your fork to test your content
178179

@@ -193,15 +194,15 @@ To publish your GitHub Pages site:
193194

194195
3. On the left menu, click **Pages**.
195196

196-
![Select pages.](./images/git-hub-stage-git-hub-pages-settings-theme.png " ")
197+
![Select pages.](./images/git-hub-stage-git-hub-pages-settings-theme1.png " ")
197198

198-
4. Under **Source**, select **main** (if it's not already selected) from the drop-down list. Click **Save**.
199+
4. Under **Branch**, select **main** (if it's not already selected) from the drop-down list. Click **Save**.
199200

200-
![Select main as source.](./images/source-main.png " ")
201+
![Select main as source.](./images/branch-main.png " ")
201202

202-
5. Optional: Under **Theme Chooser**, click **Change Theme** and select a theme of your choice.
203+
<!-- 5. Optional: Under **Theme Chooser**, click **Change Theme** and select a theme of your choice. -->
203204

204-
6. This may take a few minutes to complete. After the GitHub Pages are enabled, the message under **GitHub Pages** changes to **Your site is published at https://arabellayao.github.io/em-omc/**
205+
5. This may take a few minutes to complete. After the GitHub Pages are enabled, the message under **GitHub Pages** changes to **Your site is published at https://arabellayao.github.io/em-omc/**
205206
![Changes are published.](./images/git-hub-stage-git-hub-pages-settings-page-published.png " ")
206207

207208
## Task 8: Access your workshop on GitHub
Loading

sample-livelabs-templates/create-labs/labs/6-labs-publish/6-labs-publish.md

+81-14
Original file line numberDiff line numberDiff line change
@@ -113,31 +113,98 @@ If you want to request a green button (or a sandbox environment) for your worksh
113113
This walks you through requesting a Green Button for your workshop to run in LiveLabs Sandbox:
114114
[Video walking Green Button - LiveLabs Sandbox Request](https://otube.oracle.com/media/LiveLabsA+Green+Button+Lite/1_85wokrec)
115115

116-
After you enable the green button for your workshop, users can run the workshop in pre-provisioned environments (a.k.a. sandbox), so they don't need to register OCI Free Tier accounts. Users have to complete the workshop in a specified limited amount of time (they can extend their reservations up to 4 times). After their reservations expire, any instances they create will be destroyed.
116+
After you enable the green button for your workshop, users can run the workshop in pre-provisioned environments (a.k.a. sandbox), so they don't need to register OCI Free Tier accounts. Users have to complete the workshop in a specified limited amount of time (they can extend their reservations up to 4 times). Any resources created by the user during their reservation time will be destroyed after the reservation expires.
117117

118-
The green button is a great choice if you want users to try some not available in OCI Free Tier for free, or if the workshop setup is long and time-consuming and you want customers to skip the setup and dive directly into products and services. Note that not all services are available or can be provisioned in the green button environment.
118+
The green button is a great choice if you want users to try some features unavailable in OCI Free Tier for free or if the workshop setup is long and time-consuming and you want customers to skip the setup and dive directly into products and services. Note that not all services are available or can be provisioned in the green button environment.
119119

120-
The green Button can also be added after your workshop has already been in production.
120+
The green button can also be added to your workshop even after it is in production.
121121

122-
1. Go to WMS and find your workshop. Click the **Publishing** tab, then click **Edit** in the LiveLabs publishing entry (if available), or click **+ Publish to LiveLabs** (if you do not have a LiveLabs publishing entry already).
122+
1. You need to create a green button version of your workshop since the setup, instructions, and screenshots will differ for green button users. Refer to Lab 2 - Lab 4 to develop your workshop. Note that you should update the *workshops/sandbox/index.html* (or *workshops/livelabs/index.html*) and the *workshops/sandbox/manifest.json* (or *workshops/livelabs/manifest.json*) and all necessary lab files before the green button is live in production.
123+
124+
2. Go to WMS and find your workshop to request the green button. Click the **Publishing** tab, then click **Edit** for the LiveLabs publishing entry you wish to request green button (if available) or click **+ Publish to LiveLabs** (if you do not have a LiveLabs publishing entry already).
123125

124126
![Edit LiveLabs publishing entry](images/publishing-edit.png " ")
125127
![Request Publishing](images/publishing-tab.png " ")
126128

127-
2. Turn on the **Green Button Enabled?** button. This will trigger a notification to our LiveLabs team.
128-
![Turn on Green Button](images/gb-enabled.png " ")
129+
3. Scroll down to the **Request a Green Button section** and populate your workshop's GitHub LiveLabs/Sandbox URL.
129130

130-
3. Scroll down and fill out the **Green Button Questionnaire** to the best of your knowledge.
131-
![Green Button Questionnaire](images/gb-questionnaire.png " ")
131+
![Request green button setup](./images/request-a-green-button.png " " )
132132

133-
4. Click **Create** or **Save**.
133+
4. We offer two options to create a Green Button in LiveLabs.
134+
135+
- Green Button Lite: A Green Button Lite is a quick and easy way to set up a green button for your workshop. This option *DOES NOT* create any resources for the user but allows them to create them in an isolated environment in one of our LiveLabs tenancies. A Green Button Lite is created automatically and will be ready within 1 business day!
136+
137+
The following resources are offered in a Green Button Lite:
138+
- ATP
139+
- AJD
140+
- ADW
141+
- Standard Flex E4 Compute Instance
142+
- VCN
143+
- Cloud Shell
144+
145+
- Regular Green button: A regular Green Button can provision resources for the user but can take 1-3 weeks to develop, depending on the workshop's complexity.
146+
147+
5. To request a **Green Button Lite**,
148+
149+
1. click on **Green Button Lite** button.
150+
151+
![Click Green Button Lite](./images/click-gb-lite.png " ")
152+
153+
2. Then click **OK** on the Green Button Lite popup.
154+
155+
![Click OK in the Green Button Lite popup](./images/gb-lite-ok.png " ")
156+
157+
3. Fill out the Green Button Lite form with the options below. Specify if you would like the USER of your workshop to be able to spin up one of the noted resources. This *does not create* any resources on the users behalf. This merely allows the user to create it themselves (except for the VCN option, that option -- if checked -- will automatically provision a VCN for the user).
158+
159+
![Fill the Green Button Lite form](./images/fill-gb-lite-form.png " ")
160+
161+
4. After filling out the form, scroll up to the top of the LiveLabs Publishing Information form and click **Save** to save the changes.
162+
163+
![Fill the Green Button Lite form](./images/save-gb-lite.png " ")
164+
165+
5. The Green Button for your workshop will be created for your workshop automatically and will be live in production within 1 business day. Email us at [email protected] if you have any questions/issues with the green button.
166+
167+
![Sandbox](images/sandbox.png " ")
168+
169+
6. Be sure to test the workshop instructions against the green button setup and update them if necessary.
170+
171+
Please proceed with the below steps if you would like to request a regular green button.
172+
173+
5. To request a regular green button or update an existing Green Button,
174+
175+
1. Click the **Green Button** button.
176+
177+
![Regular Green Button](./images/request-regular-gb.png " ")
178+
179+
2. Click **OK** on the Green Button popup.
180+
181+
![Click OK Green Button](./images/click-ok-gb.png " ")
182+
183+
3. Scroll down the Request a Green Button section to view the Green Button Request instructions. Click the **Open Jira Ticket** button to open a Jira Ticket in the LiveLabs Project. You will now be directed to the Jira platform. Click on **Log In** if needed to sign into Jira.
184+
185+
![Click Open Jira ticket](./images/open-jira-ticket.png " ")
186+
187+
4. In the Jira tab, in the **Create Issue** form, fill out the **Summary** in this format in the form: **[GB] WMS ID: (insert WMS ID) LL ID: (insert LiveLabs ID) (insert Title)** if you are requesting a new green button. If you would like to update an existing Green Button, at the beginning of your description, explain what needs to change about your current green button.
188+
189+
5. Copy all the content in the sections: **Basic Questions, Policies, Image and Marketplace Questions, and Additional Information** from the WMS Green Button Information form and paste it into the **Description** field of the Jira ticket.
190+
191+
![Copy to Jira ticket ](./images/copy-to-jira-ticket.png " ")
192+
193+
6. Complete the questionnaire in the Jira ticket to your knowledge. Be sure to fill out all the relevant details in the description. Ignore other fields in the Jira ticket and click **Create**.
194+
195+
7. In WMS, scroll up to the top of the LiveLabs Publishing Information form and click **Save** to save the changes.
196+
197+
![Fill the Green Button Lite form](./images/save-gb-lite.png " ")
198+
199+
>**Note:** LiveLabs cannot handle all OCI resources for green buttons so each request will be evaluated on a case-by-case basis. Also, depending on the green button's complexity, on what services and products the workshop showcases, and if we have any existing similar green buttons, the completion time for a green button can range from 1-3 weeks. The LiveLabs team will reach out through Jira with any further questions. If you have any questions, please reach out to *[email protected]*.
200+
201+
8. After creating the green button setup for your workshop, the LiveLabs team will create a demo environment for you to test the green button setup and share the demo environment link with you. Be sure to test the green button setup and update the workshop instructions as necessary.
134202

135-
5. You need to create a green button version of your workshop since the setup, instructions, and screenshots will be different for green button users. Refer to Lab 2 - Lab 4 to develop your workshop. Note that you should update the *workshops/sandbox/index.html* (or *workshops/livelabs/index.html*) and the *workshops/sandbox/manifest.json* (or *workshops/livelabs/manifest.json*), and all necessary lab files.
203+
9. Confirm with the LiveLabs team through the WMS messaging system or by emailing to *[email protected]* mailbox that you have tested the green button setup and share your concerns if needed. If the green button setup is working as expected, let them know that the setup is working as expected, you have updated the workshop instructions accordingly, and the green button can be moved to production. Also, share the workshop livelabs/sandbox instructions link for the LiveLabs team to populate while moving the green button to production.
136204

137-
6. Our LiveLabs team will work with you to set up and test the green button for your workshop. The time varies depending on what services and products the workshop showcases, and if we have any existing green buttons similar. If you have any questions, please reach out to *[email protected]*.
205+
10. After receiving the confirmation email, the LiveLabs team will move the green button to production in 1-2 business days, turn on the green button in the WMS publishing entry, and populate the workshop URL. The LiveLabs team will keep you posted once the workshop is published.
138206

139-
7. After the green button is ready, make sure you QA the workshop. Then, the green button will be ready for use in production.
140-
![Sandbox](images/sandbox.png " ")
207+
![Sandbox](images/sandbox.png " ")
141208

142209
Congratulations on completing the Step by Step workshop to create your workshop in LiveLabs.
143210

@@ -165,7 +232,7 @@ For the workshops that are in Quarterly QA status with a last qa date of more th
165232

166233
6. After LiveLabs publishers have updated the workshop publishing status to Publish Approved, the workshop will be pushed to production within a day.
167234

168-
## **Appendix**: Troubleshooting Tips
235+
## Appendix: Troubleshooting Tips
169236

170237
### Issue 1: GitHub Merge Conflicts
171238
GitHub merge conflicts happen when you and some other contributors are changing the same content in the oracle-livelabs repositories. Merge conflicts prevent you from pushing your changes to your GitHub repository.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)