Skip to content

Commit caa5769

Browse files
committed
typo fix + terminal command change
1 parent 36a6e3b commit caa5769

8 files changed

Lines changed: 16 additions & 18 deletions

File tree

docs/concepts/cdmrc.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The `tabs` field in the `.cdmrc` is an array of strings. Once specified, wheneve
2626

2727
This is for a good UX when users don't know what should be a good entry point for the project.
2828

29-
We at codedamn do this on our codelabs and some default playground repos. You can customize this behavior or disable it completely by passing an empty array `[]` or just removing the key altogether.
29+
We at codedamn do this on our exercise labs and some default playground repos. You can customize this behavior or disable it completely by passing an empty array `[]` or just removing the key altogether.
3030

3131
## Live browser reloading
3232

@@ -52,7 +52,7 @@ playground-view: terminal-editor-browser
5252

5353
There are three possible views for playground you can specify in this configuration:
5454

55-
- `terminal-editor-browser`: This view includes terminal, editor and browser preview. It is the best and recommended view if you intend to use a frontend webserver to display output.
55+
- `terminal-editor-browser`: This view includes terminal, editor and browser preview. It is the best and recommended view if you intend to use a frontend web server to display output.
5656
- `terminal-editor`: This view includes a terminal and an editor only. It is good for programming where no web server is involved. For example, writing a sorting algorithm in C++ may not need a web server output.
5757
- `terminal-browser`: This view includes only the terminal and browser. You can combine it with `browser-link` too.
5858

@@ -89,12 +89,10 @@ Here's a dummy config file that uses all the options we have currently:
8989
9090
```yaml
9191
# terminals
92-
terminal-one: cd client yarn && yarn start
93-
terminal-two: cd server yarn && yarn dev
94-
terminal-three: echo "we're ready"
92+
terminals: ["cd client && yarn && yarn start","cd server && yarn && yarn dev","echo \"We're ready\""]
9593
# other config
96-
browser-link: https://wikipedia.org
94+
tabs: ['README.md']
9795
run-button: clear && node $$file
9896
live-reload-browser: false
99-
tabs: ['README.md']
97+
browser-link: https://wikipedia.org
10098
```

docs/concepts/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ There are a bunch of useful system environment variables available in the codeda
66
- `$PUBLIC_PORT` is the port with which the hostname is embedded by default on right (this is `1337` - hardcoded value)
77
- `$SECONDARY_PUBLIC_PORT` is the second port available (hardcoded to `1338` right now)
88
- `$TEST_FILE_NAME` contains the full absolute path to the test file you add in a course lab using "Edit Test File" button.
9-
- `$UNIT_TEST_OUTPUT_FILE` contains the full absolute path to a file which is read by codedamn systems once your evalution script ends. Once it finishes executing, our system would read it as a boolean array, and would mark all challenges as passed or failed depending on the values inside of that boolean array. For example, if the contents of the file at `$UNIT_TEST_OUTPUT_FILE` is `[true,false,true]`, then the first challenge would be marked as passed, but the second and the third challenge would be marked as failed.
9+
- `$UNIT_TEST_OUTPUT_FILE` contains the full absolute path to a file which is read by codedamn systems once your evaluation script ends. Once it finishes executing, our system would read it as a boolean array, and would mark all challenges as passed or failed depending on the values inside of that boolean array. For example, if the contents of the file at `$UNIT_TEST_OUTPUT_FILE` is `[true,false,true]`, then the first challenge would be marked as passed, but the second and the third challenge would be marked as failed.

docs/concepts/port-mapping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Every time you boot a playground, you get a unique hostname assigned to you (exa
1010

1111
This hostname belongs to your app as long as your playground has at least one collaborator online.
1212

13-
For now, these hostnames are temporary so please do not use them/hardcode them in your programs because your program would stop working the next time your playground boots afresh.
13+
For now, these host names are temporary so please do not use them/hardcode them in your programs because your program would stop working the next time your playground boots afresh.
1414

1515
This hostname has two **special ports** - 1337, 1338. Anything you run on port 1337 and 1338 **inside** the linux computer provided to you would be mapped over to `hello-world.codedamn.app:1337` and `hello-world.codedamn.app:1338` respectively.
1616

1717
In other words, whenever someone visits `hello-world.codedamn.app:1337`, we would forward all the traffic to your `localhost:1337` port. There are two main things you have to remember here:
1818

19-
- We give you TLS termination (https support) automatically. This is mandatory and not bypassable.
19+
- We give you TLS termination (https support) automatically. This is mandatory and not by passable.
2020
- This traffic passing currently works only for HTTP and WebSocket traffic. We would not proxy any raw TCP traffic (like connecting to MongoDB listening on port 1338 on the container, from your local computer on that hostname would not work)
2121

2222
The details of port mapping are provided to you in Settings menu as well:

docs/instructor-guides/io-testing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ You can use the description area to setup the Instructors for the lab. Mention a
3131

3232
Clicking on the lab icon in the sidebar of the I/O Lab will take you to the most important part of the lab. Selecting Languages for the Lab.
3333

34-
You would see a two set of options in the sidebar. The first set `Allowed Langauges` - are the set of the languages that the student will be able to solve your lab in. You can check all the languages, if you wish to provide the option for the student to write code in any language.
34+
You would see a two set of options in the sidebar. The first set `Allowed Languages` - are the set of the languages that the student will be able to solve your lab in. You can check all the languages, if you wish to provide the option for the student to write code in any language.
3535

3636
If you're creating a course on the specific language, make sure to select the applicable language only.
3737

38-
The second set of options `Available verified soultions` - decide in which languages the verified solution will be written in. As a creator you choosing one language here is enough, however if you wish to write a solution in all available languages, you can do it.
38+
The second set of options `Available verified solutions` - decide in which languages the verified solution will be written in. As a creator you choosing one language here is enough, however if you wish to write a solution in all available languages, you can do it.
3939

40-
The last input item of this section would be `Solution to generate output` - this is an imporant part of the I/O. Here you're determining which verified solution should be used to generate the output for the test cases in.
40+
The last input item of this section would be `Solution to generate output` - this is an important part of the I/O. Here you're determining which verified solution should be used to generate the output for the test cases in.
4141

4242
We'll be selecting `Python` for this guide.
4343

@@ -47,7 +47,7 @@ You would see that a two new files have opened up on your right side of the scre
4747

4848
### 5. Setting up verified solution
4949

50-
Once you've selected the languages for the verfied solution, you should be able to see two files in the text editor on the right side of your screen.
50+
Once you've selected the languages for the verified solution, you should be able to see two files in the text editor on the right side of your screen.
5151

5252
Both of the files will be having the same name, but one file would be part of the solution folder like `solution/main.py`. This file would contain the verified solution for the challenges. Now it's time to write the solution for the challenge
5353

docs/instructor-guides/video-mode-in-lab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Setting up video mode is easy.
2828
- Video Library popup would open. If you do not have existing video uploaded you want to link it with, you can upload the video for processing from `Upload Video(s)` button on top right.
2929

3030
:::info
31-
If you upload fresh set of videos, it might take all of them upto 1 hour for it to process and be ready for linking.
31+
If you upload fresh set of videos, it might take all of them up to 1 hour for it to process and be ready for linking.
3232
:::
3333

3434
- Once you link your video, save your lab. You're ready to go.

docs/setup-course.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If you're not part of the codedamn creator server, you're missing out! Our offic
5151

5252
### Move your full video course on codedamn
5353

54-
Codedamn brings its own video processing pipleine to process videos in multiple qualities for users and deliver them at scale. It is easy to upload videos inside your instructor dashboard.
54+
Codedamn brings its own video processing pipeline to process videos in multiple qualities for users and deliver them at scale. It is easy to upload videos inside your instructor dashboard.
5555

5656
#### Step 1
5757

docs/technologies/python-pytest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ You might need to have a little understanding of bash scripting. Let us understa
150150
- We move the test file you wrote earlier (in last step) to `/home/damner/code/__labtests/pytest.py`.
151151
- We then create another setup file `/home/damner/code/__labtests/processPythonResults.js`. This is because we need to parse the results outputted by the Python testing utility to reflect it on the playgrounds. You may as well create this file in python (reading the JSON report and outputting a boolean array in a file stored in env `$UNIT_TEST_OUTPUT_FILE`)
152152
- This is important because on the playground page, the way challenges work, is that they get green or red based on a JSON boolean array written inside the file in environment variable: `$UNIT_TEST_OUTPUT_FILE`
153-
- For example, once the test run suceeds, and if you write `[true,false,true,true]` inside `$UNIT_TEST_OUTPUT_FILE`, it would reflect as PASS, FAIL, PASS for 3 challenges available inside codedamn playground UI (as shown below)
153+
- For example, once the test run succeeds, and if you write `[true,false,true,true]` inside `$UNIT_TEST_OUTPUT_FILE`, it would reflect as PASS, FAIL, PASS for 3 challenges available inside codedamn playground UI (as shown below)
154154

155155
![](/images/html-css/playground-tests-2.png)
156156

docs/technologies/react.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ You might need to have a little understanding of bash scripting. Let us understa
204204
- We then create another setup file `/home/damner/code/__labtests/setup.js` with just `jsdom` as the import. This is because vitest can then use JSDOM to parse the DOM without browser. More information about this [setup file can be found in vitest docs here](https://vitest.dev/config/#setupfiles).
205205
- We then also create a custom vite config file as `config.js`. This is because we don't want to override your (or users') custom `vite.config.js` file if present. This file only loads `jsdom` and marks the `globals: true` hence importing `describe`, `test`, etc. automatically available without importing. More information about the configuration can be found here in [vitest docs](https://vitest.dev/config/#globals).
206206
- We then create a `process.js` file that can be used to process our results into a single file of boolean values. This is important because on the playground page, the way challenges work, is that they get green or red based on a JSON boolean array written inside the file in environment variable: `$UNIT_TEST_OUTPUT_FILE`
207-
- For example, once the test run suceeds, and if you write `[true,false,true,true]` inside `$UNIT_TEST_OUTPUT_FILE`, it would reflect as PASS, FAIL, PASS for 3 challenges available inside codedamn playground UI (as shown below)
207+
- For example, once the test run succeeds, and if you write `[true,false,true,true]` inside `$UNIT_TEST_OUTPUT_FILE`, it would reflect as PASS, FAIL, PASS for 3 challenges available inside codedamn playground UI (as shown below)
208208

209209
![](/images/html-css/playground-tests-2.png)
210210

0 commit comments

Comments
 (0)