Skip to content

Commit 17cdf68

Browse files
Merge pull request TheOdinProject#24399 from RTnhN/foundations/introduction_update_headings
Foundations/introduction, Foundations/installations: update headings per Style Guide
2 parents 116986a + 45a448a commit 17cdf68

File tree

6 files changed

+87
-55
lines changed

6 files changed

+87
-55
lines changed

foundations/installations/how_does_the_web_work.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
### Introduction
2+
23
Before you can understand how to program the web, you need a more rigorous understanding of the web itself than you likely have now. These concepts provide a more holistic understanding of the ecosystem in which you will be working and will enable you to talk intelligently with other developers about your work.
34

45
### Lesson Overview
6+
57
This section contains a general overview of topics that you will learn in this lesson.
68

79
* Describe what the internet is.
@@ -24,6 +26,7 @@ This section contains a general overview of topics that you will learn in this l
2426
</div>
2527

2628
### Knowledge Check
29+
2730
This section contains questions for you to check your understanding of this lesson on your own. If you’re having trouble answering a question, click it and review the material it links to.
2831

2932
* <a class="knowledge-check-link" href="https://developer.mozilla.org/en-US/docs/Learn/Common_questions/How_does_the_Internet_work">What is a network?</a>
@@ -43,6 +46,7 @@ This section contains questions for you to check your understanding of this less
4346
* <a class="knowledge-check-link" href="https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Pages_sites_servers_and_search_engines">In your own words, explain what happens when you run a search on google.com.</a>
4447

4548
### Additional Resources
49+
4650
This section contains helpful links to other content. It isn't required, so consider it supplemental.
4751

4852
* Listen to [Part 1](https://twit.tv/shows/security-now/episodes/25?autostart=false) (starts around 8:30) and [Part 2](https://twit.tv/shows/security-now/episodes/26?autostart=false) of Security Now Podcast's *How the web works* series.

foundations/introduction/asking_for_help.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,20 @@
33
Along your programming journey, you will inevitably need to ask questions in an online coding community like ours, or in conversations with your colleagues. While asking questions may seem rather simple, in a programming environment it is essential to ask well formed questions with as much context as needed so you can get the most out of asking for help. In essence, “help others help you!” This lesson will provide you with the tools to effectively ask questions in communities such as our Discord chat, Stack Overflow, and in the workplace!
44

55
### Lesson Overview
6+
67
This section contains a general overview of topics that you will learn in this lesson.
78

89
* Explain techniques for asking programming questions
910
* Explain and avoid qualities of “bad” questions
1011
* Ask effective and well formed questions
1112

12-
### Tips for Getting The Best Help Possible
13+
### Tips for Getting the Best Help Possible
1314

14-
#### <span id="provide-code-knowledge-check">Always provide your code and the surrounding context.</span>
15+
#### <span id="provide-code-knowledge-check">Always Provide Your Code and the Surrounding Context</span>
1516

1617
You can ask theoretical, vague questions, but you’re going to get theoretical, vague answers that probably won't be helpful to you and cause frustration on both ends as you and the person helping you dance around the real issue. The only time code doesn’t need to be provided is if you are asking a purely conceptual question outside of a specific project or code snippet. Additionally, provide as much context as is necessary, and zero in on the specific problem, such as pointing people to a specific function or line number in your code so people can give you the most relevant answers and quickly assist you.
1718

18-
#### Ask about the problem at hand, not the solution itself.
19+
#### Ask About the Problem at Hand, Not the Solution Itself
1920

2021
A lot of learners ask exactly how to approach a given task or assignment in this curriculum, such as the below:
2122

@@ -29,7 +30,8 @@ In sharing your attempt, people know what you’ve tried and won’t suggest thi
2930

3031
Now, if you’re completely stuck with where to start, it’s completely fine to let people know that you’re stuck. Asking where you can start and what you can research to get on the right track empowers you to be able to resolve issues largely on your own in the future, and might even empower you to help others with the same issue later on. It is also recommended that you share your pseudo code so people can nudge you in the right direction or correct any misunderstandings you may have.
3132

32-
#### Don’t take asking for more context to heart!
33+
#### Don’t Take Asking for More Context to Heart
34+
3335
People who volunteer in coding communities are here to help! But a question you may feel is coherent and “obvious” probably isn’t if you are being asked for more context. While something may seem "obvious" to a beginner, it's sometimes nowhere near "obvious" to an expert. An expert knows about many, many more situations that could cause an issue someone is experiencing, and would want to refrain from sending a learner down the wrong path. People take time out of their day to help, so make it as easy as possible for them to help you! There’s probably a good reason why they need more information, so trust their judgement and experience when they ask. Many people who help in coding chats are unpaid volunteers, and are in no way obligated to answer your query. But because they truly do want to help you, they will ask for more information when needed!
3436

3537
### Assignment
@@ -42,6 +44,7 @@ People who volunteer in coding communities are here to help! But a question you
4244
</div>
4345

4446
### Knowledge Check
47+
4548
This section contains questions for you to check your understanding of this lesson on your own. If you’re having trouble answering a question, click it and review the material it links to.
4649

4750
* <a class="knowledge-check-link" href="#provide-code-knowledge-check">Name at least one thing your question should always include.</a>

foundations/introduction/how_this_course_will_work.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
### Welcome to The Odin Project
1+
### Introduction
22

33
The Odin Project is an open-source community dedicated to providing the best information sources to take you from zero to a full-stack developer. More information can be found at The Odin Project's [about page](https://www.theodinproject.com/about).
44

5-
### Introduction
6-
75
In this unit, we'll learn about how the web works and start thinking about the basics of computer and web programming.
86

97
Each of the following sections and lessons represents essential baseline knowledge. Even if you have no intention of becoming a web developer yourself, this material should help you gain a useful understanding of the moving parts involved in creating and serving content on the web.

foundations/introduction/introduction_to_web_development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
### What Do Web Developers Do?
1+
### Introduction
22

3-
In short, web developers build and maintain websites.
3+
What do web developers do? In short, they build and maintain websites.
44

55
Web developers often work for clients who are trying to get their product or service onto the web.
66
The work is typically very project focused and involves collaborating with a team that helps to coordinate the client's needs into the end product. The client could be a tech company, an organization, or a government. The work could involve front-end, back-end, or full-stack web development.

0 commit comments

Comments
 (0)