Skip to content

Commit 4350e76

Browse files
Docs: cross-course editorial pass — tighten wording and restructure headings
1 parent 2a3e75e commit 4350e76

70 files changed

Lines changed: 805 additions & 601 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

activities/book-of-the-week.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,44 @@ parent: Activities
99

1010
Each week we invite a book author to DataTalks.Club to answer questions about their book and the topic it covers.
1111

12-
We don't regularly host this event at the moment. If you know a book author and want to ask them questions, reach out to Alexey Grigorev - we can invite them.
12+
We don't regularly host this event at the moment. If you know a book author and want to ask them questions, reach out to the DataTalks.Club team. We can invite them.
1313

1414
Archive of past book discussions: [datatalks.club/books.html](https://datatalks.club/books.html)
1515

1616
## How it works
1717

18+
To take part:
19+
1820
- Join the [`#book-of-the-week`](https://app.slack.com/client/T01ATQK62F8/C01H403LKG8) channel in Slack
1921
- Ask as many questions as you'd like
2022
- The book authors answer questions from Monday till Thursday
2123
- On Friday, the authors decide who wins free copies of their book
2224

2325
## Information for authors
2426

25-
Book of the week is an AMA-like event where the community asks authors questions about their books and the topics the books cover.
27+
Book of the week is an AMA-like event. The community asks authors questions about their books and the topics the books cover.
2628

2729
It's not a live event. The interaction happens asynchronously in Slack, so you can answer questions at a time that is convenient for you.
2830

29-
If you'd like to take part, email Alexey at [alexey@datatalks.club](mailto:alexey@datatalks.club) or find Alexey Grigorev in the [DataTalks.Club Slack](https://datatalks.club/slack.html).
31+
If you'd like to take part, email [alexey@datatalks.club](mailto:alexey@datatalks.club) or contact the DataTalks.Club team in [Slack](https://datatalks.club/slack.html).
32+
33+
## Community support
3034

31-
### What we do
35+
DataTalks.Club helps with:
3236

3337
- Promote the event in the DataTalks.Club newsletter
3438
- Announce the event internally in Slack
3539
- Give the community a place to ask questions during the week
3640
- Help select giveaway winners randomly if you prefer not to choose them yourself
3741
- Send a calendar invite to remind you to answer questions
3842

39-
DataTalks.Club has a mailing list with 120k subscribers and an average open rate of 30%, so more than 36,000 people can see the book announcement. The Slack community has 90,000 registered members, and more than 3,000 people are in the `#book-of-the-week` channel.
43+
DataTalks.Club has a mailing list with 120k subscribers and an average open rate of 30%. More than 36,000 people can see the book announcement. The Slack community has 90,000 registered members. More than 3,000 people are in the `#book-of-the-week` channel.
4044

4145
On average, authors get 10-20 questions per week.
4246

43-
### What authors do
47+
## Author responsibilities
48+
49+
Authors usually:
4450

4551
- Join Slack at least once per day from Monday to Thursday and answer questions from the community
4652
- Reply in Slack threads so the discussion stays organized
@@ -52,31 +58,35 @@ If you don't want to answer some questions, that's fine.
5258

5359
Winners can be selected randomly or based on the most interesting questions. If you want random selection, we can take care of it.
5460

55-
Ebooks are preferred because printed books can be difficult to ship. We already have agreements with Manning, O'Reilly, and Packt, so if your book is with one of these publishers, you don't need to arrange anything separately. If your book is with another publisher, we'll be happy to talk to their marketing team.
61+
Ebooks are preferred because printed books can be difficult to ship. We already have agreements with Manning, O'Reilly, and Packt. If your book is with one of these publishers, you don't need to arrange anything separately. If your book is with another publisher, we'll be happy to talk to their marketing team.
5662

57-
### What we need from you
63+
## Materials we need
64+
65+
Please send:
5866

5967
- Your bio and a picture, or a link to a website where we can take them
6068
- Optionally, social media accounts such as Twitter, LinkedIn, GitHub, and your personal website
6169
- The book cover image and description, or a link to a website where we can take them
6270
- Optionally, links to the publisher's page, book landing page, GitHub repository, or other supplemental materials
6371

64-
### Publishing answers
72+
## Publishing answers
6573

6674
Your Slack answers will be published on the DataTalks.Club website, so people can read them without logging in to Slack.
6775

68-
If you don't want to publish your answers, or you'd like to remove or edit some of them, let us know.
76+
If you don't want to publish your answers, let us know. We can also remove or edit specific answers.
6977

7078
You can look at previous discussions in the [book archive](https://datatalks.club/books.html).
7179

72-
### Typical schedule
80+
## Typical schedule
81+
82+
The usual weekly schedule:
7383

7484
- After the announcement, people start asking questions in Slack
7585
- From Monday to Thursday, come to Slack every day and answer questions
7686
- On Thursday, we'll ask whether you want to select the winners yourself or use random selection
7787
- On Friday, we'll announce the winners
7888

79-
### Feedback from authors
89+
## Feedback from authors
8090

8191
> Hi Alexey. We're only part of the way through the week but I wanted to thank you for inviting me to be part of the DataTalks.Club book of the week. The questions in Slack have been super high quality and I've been getting a lot of positive feedback via LinkedIn as well. I would highly recommend this format to any author. Thanks!
8292
>

activities/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,20 @@ All events are published on our [YouTube channel](https://www.youtube.com/c/data
1515

1616
## Events
1717

18+
Live and recorded event formats:
19+
1820
- [Podcast]({{ '/activities/podcast/' | relative_url }}) - live conversations with data science practitioners, published as podcast episodes
1921
- [Webinars]({{ '/activities/webinars/' | relative_url }}) - technical talks with slides
2022
- [Workshops]({{ '/activities/workshops/' | relative_url }}) - hands-on tutorials about technical topics
2123

2224
## Courses
2325

24-
We also run free online courses (zoomcamps) on data engineering, machine learning, MLOps, LLMs, and more. See the [courses section]({{ '/courses/' | relative_url }}) for details, or read our [guide to free online courses](https://datatalks.club/blog/guide-to-free-online-courses-at-datatalks-club.html).
26+
We also run free online courses called zoomcamps that cover data engineering, machine learning, MLOps, and LLMs. See the [courses section]({{ '/courses/' | relative_url }}) for details. You can also read our [guide to free online courses](https://datatalks.club/blog/guide-to-free-online-courses-at-datatalks-club.html).
2527

2628
## Other activities
2729

28-
- [Book of the Week]({{ '/activities/book-of-the-week/' | relative_url }}) - book authors answer community questions (currently not very active)
30+
Other formats:
31+
32+
- [Book of the Week]({{ '/activities/book-of-the-week/' | relative_url }}) - book authors answer community questions (currently not active)
2933
- [Open-Source Spotlight]({{ '/activities/open-source-spotlight/' | relative_url }}) - short demos of open-source tools by their authors
3034
- [Project of the Week]({{ '/activities/project-of-the-week/' | relative_url }}) - learn-by-doing study groups (currently inactive)

activities/open-source-spotlight.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@ We invite open-source authors to record a short demo of their tool. The format i
1111

1212
- [YouTube playlist](https://www.youtube.com/playlist?list=PL3MmuxUbc_hJ5t5nnjzC0F2zan76Dpsz0) - recordings
1313

14-
If you'd like to showcase your open-source project, reach out to Alexey Grigorev.
14+
If you'd like to show your open-source project, reach out to the DataTalks.Club team.
1515

1616
## Notes for guests
1717

1818
Please don't prepare slides - it's best when we jump into a demo directly.
1919

20-
### Plan
20+
## Plan
21+
22+
The usual structure:
2123

2224
- Intro, some info about you and about the tool (1-2 minutes)
23-
- "Welcome to Open-Source Spotlight. We invite open-source authors and ask them to show the tools they're working on. Today we have NAME. Hi NAME, tell us a few words about yourself and about the tool you want to show us."
2425
- The demo
2526
- Questions (3-4 minutes):
2627
- How many people are working on it?
@@ -35,19 +36,19 @@ After the video, please send me:
3536
- Link to your GitHub repo and documentation
3637
- Everything else you'd like to add to the description
3738

38-
### Preparation tips
39+
## Preparation tips
3940

4041
Make sure the font size is large enough (the default size is always too small).
4142

42-
- Prepare your browser, the terminal and your IDE - and other things you want to share
43-
- Good rule of thumb: the text should be visible on YouTube on 13" laptop screens without people having to go full-screen
43+
- Prepare your browser, terminal, IDE, and anything else you want to share.
44+
- Make the text visible on YouTube on 13" laptop screens without people having to go full screen.
4445

4546
Good examples:
4647

47-
- [https://youtu.be/YwjauyAflmc?t=1707](https://youtu.be/YwjauyAflmc?t=1707)
48-
- [https://youtu.be/hCAIVe9N0ow?t=65](https://youtu.be/hCAIVe9N0ow?t=65)
48+
- [Large readable terminal example](https://youtu.be/YwjauyAflmc?t=1707)
49+
- [Large readable notebook example](https://youtu.be/hCAIVe9N0ow?t=65)
4950

5051
Examples where font could be larger:
5152

52-
- [https://youtu.be/UVI30Vxzd6c?t=962](https://youtu.be/UVI30Vxzd6c?t=962)
53-
- [https://youtu.be/vzoYhI8KTlY?t=425](https://youtu.be/vzoYhI8KTlY?t=425)
53+
- [Small terminal text example](https://youtu.be/UVI30Vxzd6c?t=962)
54+
- [Small notebook text example](https://youtu.be/vzoYhI8KTlY?t=425)

activities/podcast.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ parent: Activities
99

1010
Live events where we invite data science practitioners, ML engineers, and AI researchers to share their experience. No slides - just a conversation between the guest and the host.
1111

12-
Everyone who joins the live broadcast can ask questions, and we cover them as we go. After the live event, the recording is published as a podcast episode on audio platforms like Spotify and Apple Podcasts. Transcripts and show notes are available on our website.
12+
Everyone who joins the live broadcast can ask questions, and we cover them as we go. After the live event, the recording is published as a podcast episode. It is available on Spotify, Apple Podcasts, and other audio platforms. Transcripts and show notes are available on our website.
1313

1414
- [YouTube playlist](https://www.youtube.com/playlist?list=PL3MmuxUbc_hK60wsCyvrEK2RjQsUi4Oa_) - video recordings
1515
- [All episodes](https://datatalks.club/podcast.html) - transcripts and show notes

activities/project-of-the-week.md

Lines changed: 29 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ parent: Activities
99

1010
Project of the week is a study group with focus on building things and learning by doing. Every day we have a set of tasks. We finish them together and hold each other accountable.
1111

12-
This activity is currently not active. If you'd like to organize a project of the week, reach out to Alexey Grigorev.
12+
This activity is currently not active. If you'd like to organize a project of the week, reach out to the DataTalks.Club team.
1313

1414
GitHub repository: [DataTalksClub/project-of-the-week](https://github.com/DataTalksClub/project-of-the-week)
1515

16-
## How to take part
16+
## Taking part
17+
18+
To take part:
1719

1820
- Join the [`#project-of-the-week`](https://app.slack.com/client/T01ATQK62F8/C02BP4FQH36) channel in Slack
1921
- Come to the channel every day to see the tasks
@@ -24,6 +26,8 @@ GitHub repository: [DataTalksClub/project-of-the-week](https://github.com/DataTa
2426

2527
## Past projects
2628

29+
Past topics:
30+
2731
- Docker
2832
- Python package
2933
- Getting started with Rust
@@ -36,52 +40,36 @@ GitHub repository: [DataTalksClub/project-of-the-week](https://github.com/DataTa
3640

3741
See the full list with details in the [GitHub repository](https://github.com/DataTalksClub/project-of-the-week).
3842

39-
Have other ideas? Suggest them in the [`#project-of-the-week`](https://app.slack.com/client/T01ATQK62F8/C02BP4FQH36) channel.
43+
Suggest other ideas in the [`#project-of-the-week`](https://app.slack.com/client/T01ATQK62F8/C02BP4FQH36) channel.
4044

4145
## Running the activity
4246

4347
Instructions for organizers on how to run the project of the week activity.
4448

4549
Video explaining how to make announcements in Slack:
4650

47-
[https://www.loom.com/share/6c20612326ff4d38a2be6f993b0b804b](https://www.loom.com/share/6c20612326ff4d38a2be6f993b0b804b)
51+
[Slack announcement walkthrough](https://www.loom.com/share/6c20612326ff4d38a2be6f993b0b804b)
4852

4953
Schedule messages at 3:00 PM CET for every day.
5054

51-
### First message template
52-
53-
> Hi everyone :wave:
54-
>
55-
> Welcome to project of the week! This week we will learn about recommender systems
56-
>
57-
> You can find more details here: <link>
58-
>
59-
> Plan for today:
60-
>
61-
> - Come up with a project idea.
62-
> - Select the dataset for your project.
63-
> - Create a GitHub project.
64-
> - Share your progress on Slack and in social media.
65-
66-
### Template for other days
67-
68-
> Hi everyone :wave:
69-
>
70-
> Welcome to second day of project of the week.
71-
>
72-
> Today we will start learning about <topic>.
73-
>
74-
> Hope you all have selected the dataset to use.
75-
>
76-
> Plan for today:
77-
>
78-
> - Point 1
79-
> - Point 2
80-
> - ...
81-
>
82-
> Suggested materials:
83-
>
84-
> - thing 1
85-
> - thing 2
86-
>
87-
> You will find all the details here: <link>
55+
## First message template
56+
57+
Include:
58+
59+
- Greeting
60+
- Topic for the week
61+
- Link with details
62+
- Plan for the day
63+
64+
For the first day, the plan usually asks participants to choose a project idea and select a dataset. It also asks them to create a GitHub project and share progress.
65+
66+
## Template for other days
67+
68+
Include:
69+
70+
- Greeting
71+
- Day number
72+
- Topic for the day
73+
- Plan for the day
74+
- Suggested materials
75+
- Link with details

activities/webinars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ parent: Activities
77

88
# Webinars
99

10-
Talks with slides on topics like data engineering, machine learning, MLOps, AI tools, and more. The main part is the presentation, followed by Q&A. Webinars are typically 60 minutes.
10+
Talks with slides cover data engineering, machine learning, MLOps, and AI tools. The main part is the presentation, followed by Q&A. Webinars are typically 60 minutes.
1111

1212
- [YouTube playlist](https://www.youtube.com/playlist?list=PL3MmuxUbc_hKPx7yVcu-9aAJxkCe8y_Ld) - recordings
1313
- [Upcoming and past webinars](https://datatalks.club/events.html)

activities/workshops.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,54 @@ parent: Activities
77

88
# Workshops
99

10-
Hands-on sessions with minimal slides and maximum practice. We pick a specific problem and solve it together throughout the session. Workshops are typically 90 minutes - longer than other events - so people walk away having learned something new by doing it themselves.
10+
Hands-on sessions have minimal slides and maximum practice. We pick a specific problem and solve it together throughout the session. Workshops are typically 90 minutes, so people learn by doing.
1111

1212
- [YouTube playlist](https://www.youtube.com/playlist?list=PL3MmuxUbc_hKXoe5VllAqUa0nTp0k9Mbl) - recordings
1313
- [Upcoming and past workshops](https://datatalks.club/events.html)
1414

1515
## Notes for instructors
1616

17-
### How it works
17+
## Format
1818

1919
We use Zoom for workshops.
2020

2121
- We have a Zoom call and broadcast it to our YouTube channel.
2222
- Viewers join on YouTube. They do not join Zoom.
23-
- The Zoom call is only for Alexey and the workshop instructor or instructors.
23+
- The Zoom call is only for the host and workshop instructor or instructors.
2424
- We typically start 5 minutes before to check that everything works fine.
25-
- In Zoom, Alexey starts streaming to YouTube.
25+
- The host starts streaming to YouTube from Zoom.
2626
- We only get the YouTube link after the stream starts.
27-
- After that, Alexey shares the YouTube link via Luma, Meetup, and other channels.
28-
- Alexey keeps an eye on questions from YouTube and brings them up during the session.
29-
- If a question fits what we are talking about right now, Alexey can bring it up right away.
30-
- Otherwise, Alexey brings it up at the next logical point or at the end of the session.
27+
- After that, the host shares the YouTube link via Luma, Meetup, and other channels.
28+
- The host watches questions from YouTube and brings them up during the session.
29+
- If a question fits the current topic, the host can bring it up right away.
30+
- Otherwise, the host brings it up at the next logical point or at the end of the session.
3131

32-
### Examples
32+
## Examples
3333

34-
Typically, you prepare the workshop yourself. In some cases, Alexey can prepare it too.
34+
Typically, you prepare the workshop yourself. In some cases, the DataTalks.Club team can prepare it too.
3535

3636
- [How to Evaluate MCP-powered AI Agents Beyond Accuracy using Agent GPA - Josh Reini](https://www.youtube.com/watch?v=oMmJvlNuDZE)
3737
- [From APIs to Warehouses: AI-Assisted Data Ingestion with dlt - Aashish Nair](https://www.youtube.com/watch?v=5eMytPBgmVs)
38-
- [Build a Production-Ready YouTube AI Agent with Temporal - Step-by-Step Tutorial](https://www.youtube.com/watch?v=N1gaI3Qz6vw) - example where Alexey prepared the workshop
38+
- [Build a Production-Ready YouTube AI Agent with Temporal - Step-by-Step Tutorial](https://www.youtube.com/watch?v=N1gaI3Qz6vw) - example prepared by the DataTalks.Club team
3939

40-
### Preparation
40+
## Preparation
41+
42+
Before the workshop:
4143

4244
- Download Zoom for your operating system before the workshop.
43-
- Test Zoom in advance by starting a meeting by yourself and checking that audio and video work.
45+
- Test Zoom in advance. Start a meeting by yourself, then check audio and video.
4446
- If this is your first time using Zoom, test screen sharing too.
4547
- On macOS, Zoom may ask for permissions when you share your screen, so it is better to resolve them before the workshop.
4648
- Make sure the font size is large enough. The default size is always too small.
4749
- Prepare your browser, terminal, IDE, and anything else you want to share.
48-
- Good rule of thumb: the text should be visible on YouTube on a 13" laptop screen without people having to go full screen.
50+
- Make the text visible on YouTube on a 13" laptop screen without people having to go full screen.
4951

5052
Good examples:
5153

52-
- [https://youtu.be/YwjauyAflmc?t=1707](https://youtu.be/YwjauyAflmc?t=1707)
53-
- [https://youtu.be/hCAIVe9N0ow?t=65](https://youtu.be/hCAIVe9N0ow?t=65)
54+
- [Large readable terminal example](https://youtu.be/YwjauyAflmc?t=1707)
55+
- [Large readable notebook example](https://youtu.be/hCAIVe9N0ow?t=65)
5456

5557
Examples where font could be larger:
5658

57-
- [https://youtu.be/UVI30Vxzd6c?t=962](https://youtu.be/UVI30Vxzd6c?t=962)
58-
- [https://youtu.be/vzoYhI8KTlY?t=425](https://youtu.be/vzoYhI8KTlY?t=425)
59+
- [Small terminal text example](https://youtu.be/UVI30Vxzd6c?t=962)
60+
- [Small notebook text example](https://youtu.be/vzoYhI8KTlY?t=425)

courses/course-management-platform/contributing.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ The course management platform is open source. Contributions are welcome from th
1212

1313
## GitHub Repository
1414

15+
The platform code is public:
16+
1517
- [Course Management Platform on GitHub](https://github.com/DataTalksClub/course-management-platform)
1618

17-
## How to Contribute
19+
## Contributing
1820

19-
### Reporting Issues
21+
## Reporting Issues
2022

2123
If you find a bug or have a suggestion:
2224

@@ -27,7 +29,9 @@ If you find a bug or have a suggestion:
2729
- Expected behavior
2830
- Screenshots if applicable
2931

30-
### Areas to Contribute
32+
## Areas to Contribute
33+
34+
Useful contribution areas include:
3135

3236
- Bug fixes
3337
- Feature suggestions
@@ -41,4 +45,3 @@ For questions about contributing:
4145

4246
- Join the [`#course-management-platform`](https://app.slack.com/client/T01ATQK62F8/C06EKF95CQ3) channel on Slack (see [Slack guide]({{ '/general/slack/' | relative_url }}))
4347
- Discuss your ideas before making major changes
44-

0 commit comments

Comments
 (0)