Skip to content

Commit 49f98af

Browse files
authored
clean up vi first steps (fixes #3476) (#3481)
1 parent b74ca79 commit 49f98af

File tree

8 files changed

+35
-479
lines changed

8 files changed

+35
-479
lines changed

pages/vi/vi-chat.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
Our **Discord** server is a great place to learn, discuss, and collaborate with other members to build a better Open Learning Exchange platform. The chat lets OLE’s development team and interns communicate easily, and signup is through each member’s GitHub account.
66

7-
Communication is key in every collaborative project, and OLE is no different.
7+
Communication is key in every collaborative project, and OLE is no different.
88

99
## Best Practices
1010

11-
As you complete the [Virtual Intern First Steps](vi-first-steps.md) and the [Mobile Intern First Steps](pages/mi/mi-10-steps.md), we want you to keep us updated in the discord server. Generally, you should comment in the chat when you make an issue or pull request, and then link to it. Make a mention (@*name*) of someone when you comment on their issue/pull request, then link to it. For example:
11+
As you complete the [Virtual Intern First Steps](vi-first-steps.md) aornd the [Mobile Intern First Steps](pages/mi/mi-10-steps.md), we want you to keep us updated in the discord server. Generally, you should comment in the chat when you make an issue or pull request, and then link to it. Make a mention (@*name*) of someone when you comment on their issue/pull request, then link to it. For example:
1212

13-
> Hey @dogi, just commented on your issue: [https://github.com/open-learning-exchange/open-learning-exchange.github.io/issues/15](https://github.com/open-learning-exchange/open-learning-exchange.github.io/issues/15)
13+
> @ssamikshaa, I just commented on your issue: <https://github.com/open-learning-exchange/open-learning-exchange.github.io/issues/3459#issuecomment-2433505911>
1414
1515
This good etiquette helps streamline communication between internship candidates and staff members alike! Feel free to look through the chat for more examples.
1616

pages/vi/vi-docker-development-tutorial.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,28 +53,42 @@ Next, run `ng version` to check your Angular CLI version, look for `Angular CLI:
5353

5454
## Container Setup
5555

56+
### Linux
57+
5658
1. Create a `planetdev` directory for the planet dev data:
57-
- **Linux**:
58-
```bash
59-
sudo mkdir -p /srv/planetdev && cd /srv/planetdev
60-
```
61-
- **macOS/Windows**:
62-
```bash
63-
mkdir -p ~/srv/planetdev && cd ~/srv/planetdev
64-
```
59+
60+
```bash
61+
sudo mkdir -p /srv/planetdev && cd /srv/planetdev
62+
```
63+
6564
2. Download the development yml file:
66-
- **Linux**:
67-
```bash
68-
sudo wget https://raw.githubusercontent.com/ole-vi/planet-prod-configs/main/planet-dev.yml
69-
```
70-
- **macOS/Windows**:
71-
```bash
72-
curl https://gist.githubusercontent.com/xyb994/0d14dfe302df0df0d4e8d8df0d1d5feb/raw/planet-dev-mac.yml -o planet-dev.yml
73-
```
65+
66+
```bash
67+
sudo wget https://raw.githubusercontent.com/ole-vi/planet-prod-configs/main/planet-dev.yml
68+
```
69+
7470
3. Start the containers: `sudo docker compose -f planet-dev.yml -p planet-dev up -d`
7571
4. After a minute, run `sudo docker ps -a` to verify that you have 2 runnning containers – `chatapi` and `couchdb`, the `db-init` container should have exited.
7672
- If `chatapi` service is restarting or exited, please ignore it for now as we are working on a fix
7773

74+
### macOS/Windows
75+
76+
1. Create a `planetdev` directory for the planet dev data:
77+
78+
```bash
79+
mkdir -p ~/srv/planetdev && cd ~/srv/planetdev
80+
```
81+
82+
2. Download the development yml file:
83+
84+
```bash
85+
curl https://gist.githubusercontent.com/xyb994/0d14dfe302df0df0d4e8d8df0d1d5feb/raw/planet-dev-mac.yml -o planet-dev.yml
86+
```
87+
88+
3. Start the containers: `docker compose -f planet-dev.yml -p planet-dev up -d`
89+
4. After a minute, run `docker ps -a` to verify that you have 2 runnning containers – `chatapi` and `couchdb`, the `db-init` container should have exited.
90+
- If `chatapi` service is restarting or exited, please ignore it for now as we are working on a fix
91+
7892
## Configure CORS for CouchDB with add-cors-to-couchdb project:
7993

8094
We use the [Add Cors to CouchDB](https://github.com/pouchdb/add-cors-to-couchdb) project to enable CORS on the CouchDB server. This is necessary for the Planet project to work correctly. We only need this for initialization purposes.
@@ -126,7 +140,6 @@ curl -X PUT http://localhost:2200/_node/nonode@nohost/_config/log/writer -d '"fi
126140
curl -X PUT http://localhost:2200/_node/nonode@nohost/_config/chttpd/authentication_handlers -d '"{chttpd_auth, cookie_authentication_handler}, {chttpd_auth, proxy_authentication_handler}, {chttpd_auth, default_authentication_handler}"'
127141

128142
# run the couchdb-setup.sh script to set up the couchdb database for the planet project
129-
chmod +x couchdb-setup.sh
130143
bash couchdb-setup.sh -p 2200 -i
131144
```
132145

pages/vi/vi-docker-installation.md

Lines changed: 0 additions & 111 deletions
This file was deleted.

pages/vi/vi-docker-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ docker tag treehouses/planet:chatapi treehouses/planet:chatapi-local
6262

6363
# create a dedicated directory
6464
# for mapping Docker container volumes and saving configuration files
65-
sudo mkdir /srv/planet
65+
sudo mkdir -p /srv/planet
6666
cd /srv/planet
6767

6868
# download production docker compose yml file and rename it

pages/vi/vi-first-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Take the opportunity to read more about the tools and languages we use to deepen
2020

2121
The MDwiki offers plenty of resources to help you complete these steps. You'll find a list of useful links at the end of each step. :)
2222

23-
**We also would like you to keep us regularly updated in the Discord channel as you complete these steps. We will ask you to send messages, links, and screenshots along the way, which we'll use to track your progress. Please make sure not to miss this, as it's crucial for us to track your work.**
23+
**We also would like you to keep us regularly updated in our Discord server's `#vi-software` channel as you complete these steps. We will ask you to send messages, links, and screenshots along the way, which we'll use to track your progress. Please make sure not to miss this, as it's crucial for us to track your work.**
2424

2525
A significant part of these steps is identifying problems or suggesting improvements for this MDwiki. As you complete the steps, take note of any issues you encounter or ideas for enhancements. This helps improve the MDwiki and these steps for future interns.
2626

0 commit comments

Comments
 (0)