Skip to content
This repository was archived by the owner on May 11, 2022. It is now read-only.

Commit fe16b58

Browse files
jschulerbfitzpat
jschuler
authored and
bfitzpat
committed
executable commands in quick starts
1 parent 44dac72 commit fe16b58

File tree

9 files changed

+67084
-60790
lines changed

9 files changed

+67084
-60790
lines changed

‎examples/test.didact.yaml‎

Lines changed: 110 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,135 @@
11
metadata:
2-
name: add-healthchecks
2+
name: didact-quickstarts
33
spec:
4-
displayName: Adding health checks to your sample application
4+
displayName: Using didact with quick starts
55
durationMinutes: 10
66
icon: ''
7-
description: You just created a sample application. Now, let’s add health checks
8-
to it.
9-
prerequisites: [You completed the "Getting started with a sample" quick start.]
7+
description: Let's use didact with quick starts
8+
prerequisites: [You learned how to use didact commands]
109
introduction: |-
11-
### This quick start shows you how to add health checks to your sample application.
12-
You should have previously created the **sample-app** application and **nodejs-sample** deployment using the **Get started with a sample** quick start. If you haven't, you may be able to follow these tasks with any existing deployment without configured health checks.
10+
### This quick start shows you how to use didact commands in quick starts
11+
Learn more about didact here: [Didact](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-didact)
1312
tasks:
14-
- title: Viewing the details of your sample application
13+
- title: Clipboard Commands
1514
description: |-
16-
### To view the details of your sample application:
17-
1. Go to the project your sample application was created in.
18-
2. In the **</> Developer** perspective, go to **Topology**.
19-
3. Click on the **nodejs-sample** deployment to view its details.
15+
[Copy text to clipboard](didact://?commandId=vscode.didact.copyToClipboardCommand&text=The%20fox%20jumped%20over%20the%20lazy%20dog.)
2016
21-
A side panel is displayed containing the details of your sample application.
17+
[Copy text from file to clipboard](didact://?commandId=vscode.didact.copyFileTextToClipboardCommand&extFilePath=redhat.vscode-didact/examples/clipboardTextToTerminal.txt)
2218
review:
2319
instructions: |-
24-
#### To verify you are viewing the details of your sample application:
25-
Is the side panel titled **nodejs-sample**?
20+
#### To verify that didact is working with quick starts:
21+
Were you able to execute the commands?
2622
failedTaskHelp: This task isn’t verified yet. Try the task again.
2723
summary:
28-
success: You have viewed the details of your sample app!
24+
success: You have executed didact commands!
2925
failed: Try the steps again.
30-
- title: Verifying that there are no health checks
26+
- title: Output Channel Commands
3127
description: |-
32-
### To verify that there your sample application has no health checks configured:
33-
1. View the information in the **Resources** tab in the side panel.
28+
[Open Named Output Channel](didact://?commandId=vscode.didact.openNamedOutputChannel&text=newOutputChannel)
29+
30+
[Send Text to Named Output Channel](didact://?commandId=vscode.didact.sendTextToNamedOutputChannel&text=Hello%20Didact!$$newOutputChannel)
31+
review:
32+
instructions: |-
33+
#### To verify that didact is working with quick starts:
34+
Were you able to execute the commands?
35+
failedTaskHelp: This task isn’t verified yet. Try the task again.
36+
summary:
37+
success: You have executed didact commands!
38+
failed: Try the steps again.
39+
- title: Project Scaffolding Commands
40+
description: |-
41+
[Create the tutorial project](didact://?commandId=vscode.didact.scaffoldProject&extFilePath=redhat.vscode-didact/create_extension/md-tutorial.project.didact.json)
42+
review:
43+
instructions: |-
44+
#### To verify that didact is working with quick starts:
45+
Were you able to execute the commands?
46+
failedTaskHelp: This task isn’t verified yet. Try the task again.
47+
summary:
48+
success: You have executed didact commands!
49+
failed: Try the steps again.
50+
- title: Requirements Commands
51+
description: |-
52+
[Validate all Requirements](didact://?commandId=vscode.didact.validateAllRequirements)
53+
54+
| Requirement | Status |
55+
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
56+
| [Red Hat Camel Extension Pack is Installed](didact://?commandId=vscode.didact.extensionRequirementCheck&text=extension-requirement-status$$redhat.apache-camel-extension-pack) | *Status: unknown*{#extension-requirement-status} |
57+
| [Workspace has at least one root folder](didact://?commandId=vscode.didact.workspaceFolderExistsCheck&text=workspace-folder-status) | *Status: unknown*{#workspace-folder-status} |
58+
| [CLI command is successful](didact://?commandId=vscode.didact.cliCommandSuccessful&text=cli-requirement-status$$echo%20blah) | *Status: unknown*{#cli-requirement-status} |
59+
review:
60+
instructions: |-
61+
#### To verify that didact is working with quick starts:
62+
Were you able to execute the commands?
63+
failedTaskHelp: This task isn’t verified yet. Try the task again.
64+
summary:
65+
success: You have executed didact commands!
66+
failed: Try the steps again.
67+
- title: Terminal Commands
68+
description: |-
69+
[Open the Named Terminal](didact://?commandId=vscode.didact.startTerminalWithName&text=NamedTerminal)
70+
71+
[Send Named Terminal a String](didact://?commandId=vscode.didact.sendNamedTerminalAString&text=NamedTerminal$$echo%20And%20The%20Bunnymen)
72+
73+
[Send Named Terminal a Ctrl+C](didact://?commandId=vscode.didact.sendNamedTerminalCtrlC&text=NamedTerminal)
74+
75+
[Close the Named Terminal](didact://?commandId=vscode.didact.closeNamedTerminal&text=NamedTerminal)
76+
review:
77+
instructions: |-
78+
#### To verify that didact is working with quick starts:
79+
Were you able to execute the commands?
80+
failedTaskHelp: This task isn’t verified yet. Try the task again.
81+
summary:
82+
success: You have executed didact commands!
83+
failed: Try the steps again.
84+
- title: Tutorial Commands
85+
description: |-
86+
[Open default Didact URL](didact://?commandId=vscode.didact.openTutorial)
87+
review:
88+
instructions: |-
89+
#### To verify that didact is working with quick starts:
90+
Were you able to execute the commands?
91+
failedTaskHelp: This task isn’t verified yet. Try the task again.
92+
summary:
93+
success: You have executed didact commands!
94+
failed: Try the steps again.
95+
- title: Utility Commands
96+
description: |-
97+
[Create a workspace folder -- useful when in a workspace with no folder](didact://?commandId=vscode.didact.createWorkspaceFolder)
98+
99+
[Verify all Commands](didact://?commandId=vscode.didact.verifyCommands)
34100
review:
35101
instructions: |-
36-
#### To verify there are no health checks configured:
37-
Do you see an inline alert stating that **nodejs-sample** does not have health checks?
102+
#### To verify that didact is working with quick starts:
103+
Were you able to execute the commands?
38104
failedTaskHelp: This task isn’t verified yet. Try the task again.
39105
summary:
40-
success: You have verified that there are no existing health checks!
106+
success: You have executed didact commands!
41107
failed: Try the steps again.
42-
- title: Adding health checks to your sample
108+
- title: View Commands
43109
description: |-
44-
### To add health checks to your sample:
45-
1. Add health checks to your **nodejs-sample** deployment in one of the following ways: (a) On the side panel, click on the **Actions** menu, where you will see an **Add Health Checks** menu item or (b) Click on the **Add Health Checks** link on the inline notification in the side panel.
46-
2. In the Add Health Checks form, click on the **Add Readiness Probe** link. Leave the default values, and click on the check to add the Readiness Probe.
47-
3. Click on the **Add Liveness Probe** link. Leave the default values, and click on the check to add the Liveness Probe.
48-
4. Click on the **Add Startup Probe** link. Leave the default values, and click on the check to add the Startup Probe.
49-
5. Click **Add** when you’re done.
110+
[Reload the Tutorials view](didact://?commandId=vscode.didact.reload)
50111
51-
You will be brought back to the Topology View.
112+
[Set focus to Tutorials view](didact://?commandId=didact.tutorials.focus)
52113
review:
53114
instructions: |-
54-
#### Verify that health checks are now configured:
55-
Is the inline notification gone?
56-
failedTaskHelp:
57-
This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/applications/application-health.html#odc-adding-health-checks)
58-
about this topic.
115+
#### To verify that didact is working with quick starts:
116+
Were you able to execute the commands?
117+
failedTaskHelp: This task isn’t verified yet. Try the task again.
118+
summary:
119+
success: You have executed didact commands!
120+
failed: Try the steps again.
121+
- title: Useful VS Code Commands
122+
description: |-
123+
[Open file in folder](didact://?commandId=vscode.open&projectFilePath=first-tutorial.didact.md)
124+
125+
[Start the task named 'start.task'](didact://?commandId=workbench.action.tasks.runTask&text=start.task)
126+
review:
127+
instructions: |-
128+
#### To verify that didact is working with quick starts:
129+
Were you able to execute the commands?
130+
failedTaskHelp: This task isn’t verified yet. Try the task again.
59131
summary:
60-
success: You have added health checks to your sample app!
132+
success: You have executed didact commands!
61133
failed: Try the steps again.
62-
conclusion: Your sample application now has health checks. To ensure that your application
63-
is running correctly, take the **Monitor your sample application** quick start.
64-
nextQuickStart: [template-id]
134+
conclusion: You have gone through a didact-powered quick start!
135+
nextQuickStart: []

0 commit comments

Comments
 (0)