Skip to content

Commit e044853

Browse files
authored
Update README.md
1 parent 85ec2bd commit e044853

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

README.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,41 @@
11
# Welcome to GitpodFlix! 🎬
22

3-
Hey there, new team member! 👋
3+
Hey there new developer! 👋
44

5-
Welcome to GitpodFlixproviding the next generation of streaming experiences.
5+
Welcome to GitpodFlix, where we're providing the next generation of streaming experiences.
66

7-
We're thrilled you joined. Let's get started on your first day.
7+
We're thrilled you joined let's get you shipping today !
88

9-
### At GitpodFlix we ship to production on your first day
9+
### At GitpodFlix: we ship to production on your first day
1010

11-
We know happy developers create better products. At GitpodFlix we have **zero "works on my machine" issues** because of Gitpod. Onboarding is one-click to get a running environment with everything you need to ship new fixes and features today.
11+
We know happy developers that are in flow create better products and ship more value.
1212

13-
That's why we want you to **ship to production today**.
13+
At GitpodFlix we have **zero "works on my machine" issues** because of **Gitpod**. Onboarding is **one-click to get a running environment with everything you need to ship new fixes and features today** which is why:
1414

15-
Let's get started with shipping your first fix.
15+
We expect every new developer to **ship to production on their first day**.
1616

17-
## Getting Started
17+
## Starting your development environment
1818

19-
1. **Check your email** - You should have an email invite to join the GitpodFlix organization in Gitpod as well as a link for your first GitHub issue.
20-
2. **Go to the projects catalog at [app.gitpod.io/projects](https://app.gitpod.io/projects)** - Here you'll see a list of every project in the organization that you have access to.
21-
3. **Open up GitpodFlix** - Search "GitpodFlix" in the list and click **"Create environment"** to launch your first development environment.
19+
1. **Check your email**
20+
* You should have an email invite to join the GitpodFlix organization
21+
* And a link for your first GitHub issue.
22+
3. **Go to the projects catalog**
23+
* Find it at: [app.gitpod.io/projects](https://app.gitpod.io/projects)**
24+
* Here is every project in GitpodFlix that you have access to.
25+
5. **Open up GitpodFlix**
26+
* Search "GitpodFlix" in the list and click **"Create environment"**
2227

23-
And bingo, you have your first environment up and running.
28+
And bingo! Now have your first environment up and running—that was easy.
2429

2530
![GitpodFlix in the projects catalog](./images/gitpodflix-loading.png)
2631

27-
Here you have in your environment:
32+
See above you now have:
2833

29-
1. All your dependencies
30-
2. The database running
31-
3. The backend API running
32-
4. Your web server started
34+
1. A personal, isolated, secure, performant development environment
35+
1. All required source code cloned and authenticated with git
36+
1. Any secrets and access credentials installed ready-to-go
37+
1. Your database, microservices and web server running (via "automations")
38+
1. All your dependencies installed from node to sqlite
3339

3440
## Making a code change
3541

@@ -49,9 +55,9 @@ Here you have:
4955
- All authenticated with your GitHub account
5056
- A powerful environment secure in your corporate network
5157

52-
> **Tip:** Let's rename "Gitpod Flix" to our name by updating `frontend/src/components/Navbar.jsx`. Watch the web server live reload the change.
58+
> **Tip:** Let's rename "Gitpod Flix" to our name by updating `frontend/src/components/Navbar.jsx`. <br/> Watch the web server live reload the change.
5359
54-
Now you're ready to code.
60+
Now you're officially **ready-to-code**.
5561

5662
### Explore your development environment
5763

@@ -61,7 +67,7 @@ Now you're setup why not explore:
6167
2. Connecting to your environment with the CLI `gitpod environment ssh`
6268
3. Adding dotfiles for your personal preferences
6369

64-
## ✨ How does this magic work?
70+
## ✨ How does this Gitpod magic work?
6571

6672
### Dev Container
6773

@@ -137,30 +143,31 @@ All of these are setup to be self-serve and automatically configured. **If anyth
137143
138144
## FAQs
139145
140-
### Can I run multiple environment at once?
146+
### Where is my environment running?
141147
142-
Yes.
148+
Environments run locally or remotely for different projects with different needs.
143149
144-
### What happens if the environment stops?
150+
### Can I run multiple environment at once?
145151
146-
Your code is saved—restart to continue working.
152+
Yes. The platform team have set policies to manage cost of remote environments.
147153
148-
### How do I access logs for my running services?
154+
### Can I clone multiple repositories
149155
150-
Either:
156+
Yes.
157+
158+
### Can I customize my environment?
151159
152-
1. In the editor "terminals" view
153-
2. With the Gitpod CLI (inside or outside your environment)
160+
Yes, with dotfiles.
154161
155-
### How do I customize my environment?
162+
### Can environments run locally?
156163
157-
With dotfiles in your user profile.
164+
Yes for some projects with lower security requirements—but not for others.
158165
159-
### What if I need a new project?
166+
### What happens if the environment stops?
160167
161-
Simply create a new one in the Gitpod UI.
168+
Your code is saved—simply restart to continue working.
162169
163-
### Can I connect via SSH?
170+
### Can I connect via SSH for Vim, etc?
164171
165172
Yes via the Gitpod CLI.
166173

0 commit comments

Comments
 (0)