Skip to content

Commit 8e73c2b

Browse files
authored
Merge pull request #7 from Mrcel97/documents
Added new Privacy and Chat tutorials.
2 parents 9eadf12 + 85335bc commit 8e73c2b

File tree

3 files changed

+148
-1
lines changed

3 files changed

+148
-1
lines changed

README.md

+49-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
2020
- Interface Feed
2121
- Interface Statistics
2222
- IDE Settings
23+
- Project Chat
24+
- Projects Privacy
2325
- GitHub Toolbox
2426
3. Development information
2527

@@ -176,10 +178,56 @@ At this point a ".vscode" folder with a "settings.json" file will be created in
176178

177179
If you want to change any settings, you only have to uncomment the line (Ctrl + K + U) or delete the "/**/" anotation and then change the value.
178180

181+
### Project Chat
182+
Project Chat is a feature only available for the project Owner and project Collaborators. This chat provides essential comunication between teammates while they are working.
183+
184+
You can access the chat by pressing the "Chat-icon" on the bottom-right corner of your IDE screen.
185+
186+
<p align="center">
187+
<img src="https://i.imgur.com/Z6Da7uS.png"/>
188+
</p>
189+
190+
Once the chat is open you'll be able to see the messages sent by your project collaborators. You will be able to write in the input section. You can also send messages by pressing "Enter" key or pressing "Play button" next to the text input section. Input section let us to resize it if we place the cursor at right-bottom corner of the input box.
191+
192+
<p align="center">
193+
<img src="https://i.imgur.com/diNshs1.png?1"/>
194+
</p>
195+
196+
Chat also includes a "silent-mode" to don't disturb users while they are coding. This feature will add a green dot over the chat icon as a soft-incoming-messages report.
197+
198+
<p align="center">
199+
<img src="https://i.imgur.com/08IJ5zo.png"/>
200+
</p>
201+
202+
### Projects Privacy
203+
As an extra feature to increase the collaborations in projects, TeamCode provides options to make your project public or private. Each property will modify the visivility of your project.
204+
205+
- Public projects:
206+
- Visible for every user (even non-registered users).
207+
- Only Workspace Collaborators can "Ask to write" or use the "Project Chat".
208+
- You can share this type of project providing the project URL to your teammates or providing the project name.
209+
210+
- Private projects:
211+
- Only visible for Workspace Collaborators.
212+
- You can share this type of project providing the project URL to your teammates.
213+
214+
You can change the project privacy at any moment going to "Options > Make project -state-". Where -state- will become the new privacy state of the project. Here we provide the two views:
215+
216+
- Public projects view:
217+
218+
<p align="center">
219+
<img src="https://i.imgur.com/Qk0a0ha.png"/>
220+
</p>
221+
222+
- Private projects view:
223+
224+
<p align="center">
225+
<img src="https://i.imgur.com/HG8y4rL.png"/>
226+
</p>
227+
179228
### GitHub Toolbox
180229
This Feature is only available to the project Writer. The reason is because this feature grants write permissions over the project. We can access the GitHub toolbox by pressing the GitHub button on bottom-right corner of the TeamCode project view.
181230

182-
![GitHubTools](https://i.imgur.com/itbg1FK.png)
183231
<p align="center">
184232
<img src="https://i.imgur.com/itbg1FK.png"/>
185233
</p>

src/assets/messages/tutorialMessage.md

+60
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
- Interface Feed
2020
- Interface Statistics
2121
- IDE Settings
22+
- Project Chat
23+
- Projects Privacy
2224
- GitHub Toolbox
2325

2426
## Entry level tutorial
@@ -164,6 +166,64 @@ At this point a ".vscode" folder with a "settings.json" file will be created in
164166

165167
If you want to change any settings, you only have to uncomment the line (Ctrl + K + U) or delete the "/**/" anotation and then change the value.
166168

169+
### Project Chat
170+
Project Chat is a feature only available for the project Owner and project Collaborators. This chat provides essential comunication between teammates while they are working.
171+
172+
You can access the chat by pressing the "Chat-icon" on the bottom-right corner of your IDE screen.
173+
174+
<p align="center">
175+
<img src="https://i.imgur.com/Z6Da7uS.png"/>
176+
</p>
177+
178+
![Chat-icon](https://i.imgur.com/Z6Da7uS.png)
179+
180+
Once the chat is open you'll be able to see the messages sent by your project collaborators. You will be able to write in the input section. You can also send messages by pressing "Enter" key or pressing "Play button" next to the text input section. Input section let us to resize it if we place the cursor at right-bottom corner of the input box.
181+
182+
<p align="center">
183+
<img src="https://i.imgur.com/diNshs1.png?1"/>
184+
</p>
185+
186+
![Project-Chat](https://i.imgur.com/diNshs1.png?1)
187+
188+
Chat also includes a "silent-mode" to don't disturb users while they are coding. This feature will add a green dot over the chat icon as a soft-incoming-messages report.
189+
190+
<p align="center">
191+
<img src="https://i.imgur.com/08IJ5zo.png"/>
192+
</p>
193+
194+
![Chat-notification](https://i.imgur.com/08IJ5zo.png)
195+
196+
### Projects Privacy
197+
As an extra feature to increase the collaborations in projects, TeamCode provides options to make your project public or private. Each property will modify the visivility of your project.
198+
199+
- Public projects:
200+
- Visible for every user (even non-registered users).
201+
- Only Workspace Collaborators can "Ask to write" or use the "Project Chat".
202+
- You can share this type of project providing the project URL to your teammates or providing the project name.
203+
204+
- Private projects:
205+
- Only visible for Workspace Collaborators.
206+
- You can share this type of project providing the project URL to your teammates.
207+
208+
You can change the project privacy at any moment going to "Options > Make project -state-". Where -state- will become the new privacy state of the project. Here we provide the two views:
209+
210+
- Public projects view:
211+
212+
<p align="center">
213+
<img src="https://i.imgur.com/Qk0a0ha.png"/>
214+
</p>
215+
216+
![Make-project-private](https://i.imgur.com/Qk0a0ha.png)
217+
218+
- Private projects view:
219+
220+
<p align="center">
221+
<img src="https://i.imgur.com/HG8y4rL.png"/>
222+
</p>
223+
224+
![Make-project-public](https://i.imgur.com/HG8y4rL.png)
225+
226+
167227
### GitHub Toolbox
168228
This Feature is only available to the project Writer. The reason is because this feature grants write permissions over the project. We can access the GitHub toolbox by pressing the GitHub button on bottom-right corner of the TeamCode project view.
169229

src/assets/messages/tutorialMessage.ts

+39
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ export var tutorialMessage =
1717
- Interface Feed
1818
- Interface Statistics
1919
- IDE Settings
20+
- Project Chat
21+
- Projects Privacy
2022
- GitHub Toolbox
2123
2224
## Entry level tutorial
@@ -163,6 +165,43 @@ At this point a ".vscode" folder with a "settings.json" file will be created in
163165
164166
If you want to change any settings, you only have to uncomment the line (Ctrl + K + U) or delete the "/**/" anotation and then change the value.
165167
168+
### Project Chat
169+
Project Chat is a feature only available for the project Owner and project Collaborators. This chat provides essential comunication between teammates while they are working.
170+
171+
You can access the chat by pressing the "Chat-icon" on the bottom-right corner of your IDE screen.
172+
173+
![Chat-icon](https://i.imgur.com/Z6Da7uS.png)
174+
175+
Once the chat is open you'll be able to see the messages sent by your project collaborators. You will be able to write in the input section. You can also send messages by pressing "Enter" key or pressing "Play button" next to the text input section. Input section let us to resize it if we place the cursor at right-bottom corner of the input box.
176+
177+
![Project-Chat](https://i.imgur.com/diNshs1.png?1)
178+
179+
Chat also includes a "silent-mode" to don't disturb users while they are coding. This feature will add a green dot over the chat icon as a soft-incoming-messages report.
180+
181+
![Chat-notification](https://i.imgur.com/08IJ5zo.png)
182+
183+
### Projects Privacy
184+
As an extra feature to increase the collaborations in projects, TeamCode provides options to make your project public or private. Each property will modify the visivility of your project.
185+
186+
- Public projects:
187+
- Visible for every user (even non-registered users).
188+
- Only Workspace Collaborators can "Ask to write" or use the "Project Chat".
189+
- You can share this type of project providing the project URL to your teammates or providing the project name.
190+
191+
- Private projects:
192+
- Only visible for Workspace Collaborators.
193+
- You can share this type of project providing the project URL to your teammates.
194+
195+
You can change the project privacy at any moment going to "Options > Make project -state-". Where -state- will become the new privacy state of the project. Here we provide the two views:
196+
197+
- Public projects view:
198+
199+
![Make-project-private](https://i.imgur.com/Qk0a0ha.png)
200+
201+
- Private projects view:
202+
203+
![Make-project-public](https://i.imgur.com/HG8y4rL.png)
204+
166205
### GitHub Toolbox
167206
This Feature is only available to the project Writer. The reason is because this feature grants write permissions over the project. We can access the GitHub toolbox by pressing the GitHub button on bottom-right corner of the TeamCode project view.
168207

0 commit comments

Comments
 (0)