Skip to content

Commit 784143d

Browse files
Add jobs, community guidelines, and promotion docs
- Add jobs section with rules/templates, relevant jobs list, and suspicious job postings guide - Move community guidelines from main site: code of conduct, discussions, asking for help, promotion - Add promotion templates for events, content, social, and shameless promotion channels - Update site title to "DataTalks.Club Documentation" - Update Slack page nav order
1 parent 25fbacc commit 784143d

File tree

13 files changed

+452
-2
lines changed

13 files changed

+452
-2
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ theme: just-the-docs
1616
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
1717
# You can create any custom variable you would like, and they will be accessible
1818
# in the templates via {{ site.myvariable }}.
19-
title: DataTalks.Club Zoomcamps Notes and Resources
19+
title: DataTalks.Club Documentation
2020
description: A collection of notes and resources for the DataTalks.Club Zoomcamps, our free courses.
2121
baseurl: "" # the subpath of your site, e.g. /blog
2222
url: "https://datatalks.club" # the base hostname & protocol for your site, e.g. http://example.com
106 KB
Loading
137 KB
Loading

general/guidelines.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Community Guidelines"
3+
layout: default
4+
nav_order: 2
5+
parent: General
6+
has_children: true
7+
---
8+
9+
# Community guidelines
10+
11+
Thank you for joining our community! We hope you'll like it here.
12+
13+
DataTalks.Club is a place to talk, learn, discuss, and share. To ensure our discussions remain organized, productive, and welcoming for everyone, we've established these community guidelines.
14+
15+
- [Code of conduct]({{ '/general/guidelines/code-of-conduct/' | relative_url }}) - our expectations for respectful behavior
16+
- [Discussions]({{ '/general/guidelines/discussions/' | relative_url }}) - how to communicate effectively, use threads, and keep channels organized
17+
- [Asking for help]({{ '/general/guidelines/asking-for-help/' | relative_url }}) - how to ask questions, share errors, and get homework help
18+
- [Promotion]({{ '/general/guidelines/promotion/' | relative_url }}) - where and how to promote your work, events, and content
19+
20+
## Channels
21+
22+
Our Slack workspace is organized into channels to keep discussions focused and easy to find. Using the right channel helps ensure your message reaches the right people and keeps our workspace organized.
23+
24+
When you post in the appropriate channel, you're more likely to get helpful responses from people who are interested in that topic. For example, instead of asking a machine learning question in [`#general`](https://app.slack.com/client/T01ATQK62F8/C01B6N9FZTN), post it in [`#datascience`](https://app.slack.com/client/T01ATQK62F8/C01BQDWEAHW) where ML enthusiasts actively participate.
25+
26+
For a full list of channels, see the [Slack channels page]({{ '/general/slack/' | relative_url }}).
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Asking for Help"
3+
layout: default
4+
nav_order: 2
5+
parent: Community Guidelines
6+
grand_parent: General
7+
---
8+
9+
# Asking for help
10+
11+
If you get stuck, our Slack community is the right place to ask for help. Our members are generally happy to assist, but following these guidelines will make it much easier for others to help you effectively.
12+
13+
## Avoid meta questions
14+
15+
Meta questions are questions about asking questions (e.g., "Can I ask a question about X?"). They add an unnecessary step and delay getting the help you need.
16+
17+
[Don't ask to ask, just ask](https://dontasktoask.com/). If you have a question, post it directly in the appropriate channel. The people who can help will see it and respond.
18+
19+
Examples of meta questions to avoid:
20+
21+
- "Can I ask a question about data science here?" - just ask your data science question directly. That's what this Slack exists for.
22+
- "Is there anyone who knows marketing? I have a question about it." - just ask your marketing question directly. If someone knows the answer, they'll respond.
23+
- "Has anyone done Machine Learning Zoomcamp? I have a question about it." - just ask your question about Machine Learning Zoomcamp. If someone has done it, they'll answer.
24+
25+
## Code problems and errors
26+
27+
When something doesn't work and you need help figuring it out, we'll be happy to help. To get the best assistance quickly, please follow these recommendations:
28+
29+
- Use threads for errors. First describe the problem briefly in the main channel, then put the actual error message and code in a thread.
30+
- Copy-paste text, don't screenshot. Don't take screenshots of your code or terminal output. Instead, copy-paste the error message and code as text. Use code blocks (three backticks) to format your code. Text is searchable, easier to read, and allows helpers to copy your code if needed.
31+
- Never photograph your screen. Don't take pictures of your code with a phone. It's even harder to read than screenshots. Always copy-paste text. In rare cases when you need to show what happens on your screen visually (like a UI issue), a screenshot is acceptable, but code and errors should always be text.
32+
33+
## Homework help
34+
35+
We're generally happy to help with your homework, provided that you show genuine effort from your side and are transparent about the source of your question.
36+
37+
- Show your work. Don't just copy-paste an exercise and expect others to solve it for you. Share what you've tried, what you understand, and where you're stuck.
38+
- Be transparent. Clearly state that it's a homework assignment. This helps people provide appropriate guidance (teaching concepts rather than just giving answers).
39+
- Ask for guidance, not answers. Frame your question to ask for help understanding concepts or debugging your approach, rather than asking for the complete solution.
40+
41+
For more detailed guidance on asking homework questions effectively, consult [this guide from StackOverflow](https://meta.stackoverflow.com/questions/334822/how-do-i-ask-and-answer-homework-questions).
42+
43+
The same principles apply to interview take-home assignments. We're happy to help, but be transparent and focus on understanding concepts rather than getting complete solutions.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Code of Conduct"
3+
layout: default
4+
nav_order: 0
5+
parent: Community Guidelines
6+
grand_parent: General
7+
---
8+
9+
# Code of conduct
10+
11+
Our community is built on mutual respect, kindness, and a shared passion for data science. Be respectful and remember that there's a human on the other side of the screen.
12+
13+
While we don't have our own separate code of conduct, we follow the [Python Software Foundation's Code of Conduct](https://www.python.org/psf/conduct/). Please read the "Inappropriate Behavior" section to understand what we consider unacceptable.
14+
15+
In addition to the behaviors outlined in the Python Software Foundation's code, here are specific examples of inappropriate behavior in our community:
16+
17+
- Judging the question or the person asking the question ("this is a stupid question and everyone who can read docs knows the answer")
18+
- Soliciting any kind of personal information (such as marital status, sexual orientation, phone number, address, income, etc)
19+
- Asking for personal or professional details in DM (such as location, current job, or skills)
20+
- Asking people to share their profiles (such as LinkedIn or Upwork)
21+
- Offering collaboration in DM without prior public communication
22+
- Continuing one-on-one communication after requests to cease

general/guidelines/discussions.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Discussions"
3+
layout: default
4+
nav_order: 1
5+
parent: Community Guidelines
6+
grand_parent: General
7+
---
8+
9+
# Taking part in discussions
10+
11+
Effective communication makes our community more valuable for everyone. Following these principles helps ensure your messages get the attention they deserve and contribute to building our shared knowledge base.
12+
13+
Key principles:
14+
15+
- Do not double post. Select the best channel for your message and post it only once. Posting the same message in multiple channels creates noise and fragments the discussion.
16+
- Avoid asking questions in DM. If you ask your question in a public channel, others will also benefit from the answers. Public discussions create a knowledge base that helps the entire community.
17+
- Use [threads](https://slack.com/help/articles/115000769927-Use-threads-to-organize-discussions-). Threads help keep discussions organized and make it easier to follow conversations, especially in active channels.
18+
19+
## Thread best practices
20+
21+
- Put everything in one message. Don't break your question into multiple messages. This makes it easier for others to understand the full context at once.
22+
- Use threads for long content. For long questions, write a few sentences in the first message to provide context, then put the rest in a thread. This keeps the main channel readable and scannable.
23+
- Put code in threads. If there's a code snippet (more than 5 lines of code), put it inside the thread. This prevents long code blocks from cluttering the main channel.
24+
- Use "also send to channel" sparingly. Avoid using this feature unless it's really necessary. Most thread replies don't need to appear in the main channel.
25+
- Separate multiple questions. If your question contains multiple distinct questions, break them into separate messages so each can be answered in its own thread.
26+
27+
## Additional tips
28+
29+
- Provide context when sharing links. Don't just share a link and expect others to jump in. Share your thoughts, explain why it's interesting or relevant, and include a clear question in your message. "Any thoughts on this?" is not a clear question - be specific about what you'd like to discuss.
30+
- Be concise. While it's important to provide context, try to be concise in your questions when possible. Not everyone has time to read lengthy messages. If you need to provide extensive background, use the thread approach mentioned above.
31+
- Don't delete answered questions. Your question and its answer will help others who might have a similar problem. This builds our community knowledge base.

general/guidelines/promotion.md

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
title: "Promotion"
3+
layout: default
4+
nav_order: 3
5+
parent: Community Guidelines
6+
grand_parent: General
7+
---
8+
9+
# Promotion
10+
11+
Promoting your work is welcome - for both companies and individuals. We believe that sharing valuable content, events, and tools benefits our entire community. However, to keep our workspace organized and ensure promotions add value rather than create noise, we have specific channels and guidelines for this.
12+
13+
## Where to promote
14+
15+
We have four dedicated channels for promotions:
16+
17+
- [`#events`](https://app.slack.com/client/T01ATQK62F8/C01BDQVAS5P) - events that you organize or events that you find interesting
18+
- [`#interesting-content`](https://app.slack.com/client/T01ATQK62F8/C02N6N3S1FV) - content you published or content you find interesting
19+
- [`#shameless-social`](https://app.slack.com/client/T01ATQK62F8/C02MS2K0ACF) - for all social links: Twitter, LinkedIn, etc.
20+
- [`#shameless-promotion`](https://app.slack.com/client/T01ATQK62F8/C01F53D373M) - for everything else
21+
22+
If you want to share a job, use [`#jobs`](https://app.slack.com/client/T01ATQK62F8/C01BFQBRB5Z). If you're looking for a job, use [`#job-search`](https://app.slack.com/client/T01ATQK62F8/C06A1QBFJ94). See [job posting rules]({{ '/general/jobs/' | relative_url }}).
23+
24+
## Rules
25+
26+
- Posts in the shameless channels should follow the template (see below)
27+
- Posting the same content in multiple channels is not allowed
28+
- Posting promotional content outside of these 4 channels is not allowed
29+
- Don't post more than two promotional posts per week
30+
- Don't include more than one link per post
31+
- Non-relevant topics aren't allowed
32+
- If what you promote isn't free, you should mention the price
33+
- Don't share files like docx documents or pdf, use these channels only for sharing links
34+
- Don't make the post too long (if it doesn't fit one phone screen, it's too long)
35+
- Remove the previews, if there's more than one
36+
- Don't make your `#welcome` message a pitch. Introduce yourself as a person, not your tool or agency
37+
- The content must be in English
38+
- Think of the reader: why is it relevant for them? Why should they actually click on your link?
39+
40+
Messages that don't follow these rules will be deleted.
41+
42+
## Templates
43+
44+
We ask that your posts in the shameless channels follow a template.
45+
46+
How to use it:
47+
48+
- Replace the <placeholders> with your content
49+
- Try to keep the formatting (e.g. bold fonts)
50+
- Don't be sloppy and follow the punctuation rules:
51+
- Use ":", not ";"
52+
- There should be no space before ":" and a space after ":"
53+
- Don't use "everyone" for the "who is it for" part
54+
55+
### For [`#events`](https://app.slack.com/client/T01ATQK62F8/C01BDQVAS5P):
56+
57+
> <Title of the event>
58+
>
59+
> **Date:** &lt;date and time, don't forget the time zones&gt;<br>
60+
> **Who is it for:** &lt;data scientists, data engineers, ML engineers, managers, etc&gt;<br>
61+
> **Why is it relevant:** &lt;describe what's in there for the attendees&gt;<br>
62+
> **Price:** &lt;free or price&gt;
63+
>
64+
> &lt;Anything else you'd want to add&gt;
65+
>
66+
> **Registration link:** &lt;link&gt;
67+
68+
Example:
69+
70+
<img src="{{ '/assets/images/guidelines/example-events.png' | relative_url }}" alt="Example of a good events post" width="80%">
71+
72+
### For [`#interesting-content`](https://app.slack.com/client/T01ATQK62F8/C02N6N3S1FV):
73+
74+
> &lt;Title of the content&gt; (&lt;content type: video, blog, podcast, etc&gt;)
75+
>
76+
> **Who is it for:** &lt;data scientists, data engineers, ML engineers, managers, etc&gt;<br>
77+
> **Why is it relevant:** &lt;describe what's in there for the readers/listeners/etc&gt;
78+
>
79+
> &lt;Anything else you'd want to add&gt;
80+
>
81+
> &lt;link&gt;
82+
83+
### For [`#shameless-social`](https://app.slack.com/client/T01ATQK62F8/C02MS2K0ACF):
84+
85+
> &lt;What is it?&gt;
86+
>
87+
> **Who is it for:** &lt;data scientists, data engineers, ML engineers, managers, etc&gt;<br>
88+
> **Why is it relevant:** &lt;describe what's in there for the readers/listeners/etc&gt;
89+
>
90+
> &lt;Anything else you'd want to add&gt;
91+
>
92+
> &lt;link&gt;
93+
94+
### For [`#shameless-promotion`](https://app.slack.com/client/T01ATQK62F8/C01F53D373M):
95+
96+
> &lt;What is it?&gt;
97+
>
98+
> **Who is it for:** &lt;data scientists, data engineers, ML engineers, managers, etc&gt;<br>
99+
> **Why is it relevant:** &lt;describe what's in there for the readers/listeners/etc&gt;
100+
>
101+
> &lt;Anything else you'd want to add&gt;
102+
>
103+
> &lt;link&gt;
104+
105+
Example:
106+
107+
<img src="{{ '/assets/images/guidelines/example-shameless-promotion.png' | relative_url }}" alt="Example of a good shameless promotion post" width="80%">
108+
109+
## Surveys, product discovery, and feedback requests
110+
111+
Messages that ask the community for feedback on your product, service, or tool are considered promotional and should be posted in [`#shameless-promotion`](https://app.slack.com/client/T01ATQK62F8/C01F53D373M). This includes:
112+
113+
- Surveys and research: any requests to fill out surveys or participate in research
114+
- Product feedback: requests for feedback on products, tools, or services
115+
- User interviews: requests to talk to community members about their needs or pain points
116+
- Beta testing: invitations to test new products or features
117+
118+
Examples of promotional feedback requests:
119+
120+
- "We're conducting a survey to better understand how people use ____."
121+
- "We'd like to show you our product and get some feedback from you."
122+
- "We're working on ____ and would like to talk to data scientists and ML engineers to understand their pain points."
123+
- "We're working on a tool to do ____ and we're wondering if it's useful."
124+
125+
User research, product discovery, and feedback requests are all considered promotional content and must follow the same guidelines as other promotions.
126+
127+
## Rules for vendors and company representatives
128+
129+
If you represent a company and suggest using your services or products when answering questions in the community, you must clearly indicate your affiliation. Transparency is essential - community members deserve to know when recommendations come from someone with a commercial interest.
130+
131+
For example, if someone asks about ML monitoring tools and you work for a company that provides such tools, you can recommend it, but you must clearly state your affiliation (e.g., "I work at [Company Name], and we offer [product] which might help...").
132+
133+
## Unsolicited promotions in DMs
134+
135+
We do not welcome unsolicited promotional messages in DMs. Violating this rule will result in a ban.
136+
137+
Unsolicited DMs feel invasive and spammy. They violate people's privacy and create a negative experience. If someone wants to learn about your product or service, they'll reach out to you after seeing your post in the appropriate channel.
138+
139+
What counts as unsolicited promotion:
140+
141+
- Sending promotional messages about products or services via DM
142+
- Mass-sending your CV or resume in DMs
143+
- Promoting yourself and your services via DM
144+
- Offering collaboration in DMs without prior public communication
145+
146+
If you want to collaborate with someone, first engage with them in public channels before reaching out via DM. This ensures the interaction is welcome and builds on an existing relationship.
147+
148+
If you receive unsolicited promotional DMs, please report it to Alexey Grigorev. We take this seriously and will take action to protect the community.
149+
150+
## Non-relevant promotions
151+
152+
The promotional content must be relevant to our data science community. It should be related to data science, machine learning, data engineering, analytics, or closely related fields. If it's not relevant, don't post it.
153+
154+
Examples of content not relevant for this community:
155+
156+
- COVID surveys for $5 (unless specifically about data science/ML applications)
157+
- Coupon codes for lawn mowers, pizzas, or other unrelated products
158+
- Photoshop alternatives or general design tools
159+
- Databases with contact information (unless for data science purposes)
160+
- General sales tools unrelated to data
161+
- Wellness apps unrelated to data science
162+
- General business services with no data science connection
163+
164+
Such messages will be removed without a warning. Repeated posting of irrelevant content may result in a ban.

general/jobs.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Jobs"
3+
layout: default
4+
nav_order: 3
5+
parent: General
6+
has_children: true
7+
---
8+
9+
# Jobs
10+
11+
Guidelines for posting and finding jobs in our Slack community.
12+
13+
- [Rules and templates]({{ '/general/jobs/rules/' | relative_url }}) - posting rules, channel guidelines, and message templates
14+
- [Relevant jobs]({{ '/general/jobs/relevant-jobs/' | relative_url }}) - what types of jobs are appropriate for our community
15+
- [Suspicious job postings]({{ '/general/jobs/suspicious-job-postings/' | relative_url }}) - how to spot scams and protect yourself

general/jobs/relevant-jobs.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "Relevant Jobs"
3+
layout: default
4+
nav_order: 1
5+
parent: Jobs
6+
grand_parent: General
7+
---
8+
9+
# Relevant jobs
10+
11+
The jobs you post must be specific and relevant to the community.
12+
13+
Examples of relevant jobs:
14+
15+
- Data/product analyst
16+
- Data scientist
17+
- Machine learning engineer
18+
- AI engineer
19+
- Data engineer
20+
- Analytics engineer
21+
- Developer advocate
22+
- Software engineer / Python developer
23+
24+
Examples of non-relevant jobs:
25+
26+
- Full-stack developers
27+
- Blockchain developers
28+
- Joomla/wordpress developers
29+
- Php developers
30+
- Accountants
31+
- Bookkeepers
32+
- Designers
33+
- Assistants
34+
35+
Examples of non-specific jobs:
36+
37+
- "We're looking for students"
38+
39+
Non-relevant and/or non-specific job postings will be deleted.

0 commit comments

Comments
 (0)