Skip to content

Commit 550823d

Browse files
MABLokaswiftplicityreevejd
authored
Updated kb (#44)
* added more details on how to access the proxy server * improved clarity * tails * added more details and changed structure to match the new info * added more details and changed structure to match the new info * added more details and changed structure to match the new info * added more details and changed structure to match the new info * updated kb to be comprehensive for both users and sn-assistant, added github actions tests * Update docs/troubleshooting.md Co-authored-by: boyun <[email protected]> * Update docs/Lab Tools/Cloud IDE/cloud-ide-kubernetes.md Co-authored-by: boyun <[email protected]> * Update docs/Lab Tools/Cloud IDE/cloud-ide-openshift.md Co-authored-by: boyun <[email protected]> * Update docs/Lab Tools/Cloud IDE/cloud-ide.md Co-authored-by: boyun <[email protected]> * Update docs/troubleshooting.md Co-authored-by: boyun <[email protected]> * Update docs/troubleshooting.md Co-authored-by: boyun <[email protected]> * Update troubleshooting.md added a description to how the skills network toolbox looks like * added a small description to sn toolbox and an image * This reverts commit 2426e29. have diverged, * added an image of sn network toolbox * Update .tool-versions yep Co-authored-by: James Reeve <[email protected]> * Update docs/Lab Tools/Cloud IDE/Code-Engine.md Co-authored-by: James Reeve <[email protected]> * Update docs/Lab Tools/Cloud IDE/Code-Engine.md Co-authored-by: James Reeve <[email protected]> * Update docs/Lab Tools/Cloud IDE/Code-Engine.md Co-authored-by: James Reeve <[email protected]> * Update docs/Lab Tools/Cloud IDE/cloud-ide-kubernetes.md Co-authored-by: James Reeve <[email protected]> * more accurate description of launch application * Update docs/Lab Tools/Cloud IDE/Code-Engine.md Co-authored-by: James Reeve <[email protected]> * instruction to deal with kernel status unknown, included the general base directory in cloud IDE * Update docs/troubleshooting.md Co-authored-by: James Reeve <[email protected]> * de-duplicated cloudIDE files * Update docs/Lab Tools/Cloud IDE/cloud-ide-kubernetes.md Co-authored-by: James Reeve <[email protected]> * Update docs/Lab Tools/Cloud IDE/cloud-ide-openshift.md Co-authored-by: James Reeve <[email protected]> * resolved comments --------- Co-authored-by: boyun <[email protected]> Co-authored-by: James Reeve <[email protected]>
1 parent 1655ee0 commit 550823d

File tree

13 files changed

+1162
-124
lines changed

13 files changed

+1162
-124
lines changed

.github/workflows/test.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- master
8+
pull_request:
9+
branches:
10+
- main
11+
- master
12+
schedule:
13+
- cron: '0 0 * * *'
14+
15+
jobs:
16+
test:
17+
name: Tests if the code builds successfully
18+
runs-on: ubuntu-latest
19+
if: github.event_name != 'schedule'
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: 20
28+
cache: yarn
29+
30+
- name: Install Dependencies
31+
run: yarn install
32+
33+
- name: Test Build
34+
run: yarn build
35+
36+
- name: Test Serve
37+
run: yarn serve & sleep 10
38+
39+
- name: Test curl
40+
run: |
41+
RESPONSE=$(curl -s -X GET http://localhost:3000)
42+
if echo "$RESPONSE" | grep -q "Skills Network Labs Knowledgebase"; then
43+
echo "Response contains expected text."
44+
else
45+
echo "Response does not contain expected text."
46+
exit 1
47+
fi

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
yarn 1.22.22

docs/Lab Tools/cloud-ide.md renamed to docs/Lab Tools/Cloud IDE/_CloudIDECommon.mdx

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
2-
sidebar_position: 4
3-
---
1+
Cloud IDE is an online integrated development environment that closely mimics Visual Studio Code (VS Code). It offers users a familiar interface and functionality, making it accessible to those already comfortable with VS Code. This cloud-based platform supports VS Code plugins and provides a comprehensive set of development tools. Users can access their development environment from any location, eliminating the need for local installation. Cloud IDE is designed as a learning environment, but the skills and familiarity gained here are directly transferable to Visual Studio Code. This design ensures that learners can easily transition from educational projects to professional development work, bridging the gap between learning and real-world application in the software development industry.
42

5-
# Cloud IDE
3+
## Working Directory
64

7-
Cloud IDE is an online integrated development environment that closely mimics Visual Studio Code (VS Code). It offers users a familiar interface and functionality, making it accessible to those already comfortable with VS Code. This cloud-based platform supports VS Code plugins and provides a comprehensive set of development tools. Users can access their development environment from any location, eliminating the need for local installation. Cloud IDE is designed as a learning environment, but the skills and familiarity gained here are directly transferable to Visual Studio Code. This design ensures that learners can easily transition from educational projects to professional development work, bridging the gap between learning and real-world application in the software development industry.
5+
The base directory for all learner projects is ```/home/project```. All files and folders created during lab exercises will be stored in this directory by default.
86

97
### Layout
108

@@ -16,13 +14,13 @@ This area is divided into two sections:
1614
- Tai's Chat Interface: This interface facilitates communication between the learner and Tai, featuring chat history, and learners' message input field.
1715
- Lab instructions: These instructions guide learners through the learning activities and exercises.
1816

19-
### Cloud IDE Features
17+
## Cloud IDE Features
2018

2119
Cloud IDE empowers learners with a comprehensive IDE experience, including:
2220
- File/folder management: Organize and manage files and folders efficiently.
2321
- Terminal: Execute commands and interact with the underlying operating system.
2422

25-
#### Skills Network Toolbox:
23+
## Skills Network Toolbox:
2624

2725
Within Cloud IDE, learners can access the Skills Network Toolbox by clicking the Skills Network Toolbox Icon button located on the left-hand side of the Cloud IDE menu bar. This toolbox offers a variety of tools to enhance the learning experience and facilitate completion of labs:
2826

@@ -50,4 +48,37 @@ Within Cloud IDE, learners can access the Skills Network Toolbox by clicking the
5048
- Noun-phrases
5149
- Relations (Transformer)
5250
- Syntax
53-
- Launch Application - This is how you view the application you run within Cloud IDE. This will open a tab either within Cloud IDE or your browser
51+
- Launch Application - This is how you view the application you run within Cloud IDE.
52+
53+
#### Viewing your running Applications
54+
55+
As part of your lab, you may start a web server that accepts traffic to:
56+
57+
- **Preview static sites or front-end projects:**
58+
Viewing your HTML/CSS/JS projects with live-server.
59+
60+
- **Integration testing:**
61+
Test APIs or webhooks from apps running inside the IDE. For example, if your backend server runs in the IDE, you can point Postman or a front-end app to the proxied URL.
62+
63+
- **Cross-browser testing:**
64+
Access the proxied app from different browsers on the same machine or on a device that can reach the proxy URL, to test responsiveness and behavior.
65+
66+
After you've done this, you can use the launch application button to view your application.
67+
68+
#### How to use:
69+
70+
1. **Start your server**
71+
- If you use the built-in live server, a notification will display the port that was opened.
72+
73+
2. Go to **Skills Network Toolbox**, access **"Launch Application"** tool and input the port.
74+
75+
3. **Access your application:**
76+
- Click the **"Your Application"** button to open the server inside the Cloud IDE, or
77+
- Open it in a new browser tab.
78+
79+
---
80+
81+
## DISCLAIMER
82+
83+
- If the user is inactive for an hour, the session will be deleted
84+
- After 12 hours the session will be deleted, even if the user is active

0 commit comments

Comments
 (0)