-
Notifications
You must be signed in to change notification settings - Fork 7
[Intro Video #95] Add draft video script for new contributor intro walkthrough #125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+138
−0
Merged
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f7de757
adding script for otel intro
anarwal 42edd34
update file name
anarwal da6704c
update as per feedback
anarwal a56b064
Update scripts/01-intro.md
anarwal f174fe3
Update scripts/01-intro.md
anarwal f12ce45
Update scripts/01-intro.md
anarwal 06efd91
Merge branch 'main' into main
anarwal e3b0f8a
updating as per feedback
anarwal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| # OpenTelemetry New Contributor Walkthrough — Draft Video Script | ||
|
|
||
| **Target length:** 4–6 minutes | ||
| **Audience:** Someone interested in contributing to OpenTelemetry but unsure where to begin. | ||
|
|
||
| ## 1. Welcome — Starting at OpenTelemetry.io (~30 sec) | ||
|
|
||
| **On screen:** Open `opentelemetry.io`. | ||
|
|
||
| **Narration:** | ||
|
|
||
| Welcome! If you're interested in contributing to OpenTelemetry but aren't sure where to start, this video will walk you through the main community resources. | ||
|
|
||
| We'll start from the OpenTelemetry website and find our way to the contributor documentation, GitHub community, Special Interest Groups, CNCF Slack, and finally some issues you can use to make your first contribution. | ||
|
|
||
| You don't need to already be an OpenTelemetry expert to get involved. Plenty of contributors start with documentation fixes or issue triage. | ||
|
|
||
| --- | ||
|
|
||
| ## 2. Finding the Contribution Guide (~45 sec) | ||
|
|
||
| **On screen:** Navigate from `opentelemetry.io` to the community/contribution resources and open the contributor documentation. | ||
|
|
||
| **Narration:** | ||
|
|
||
| From the OpenTelemetry website, navigate to the community and contribution resources. That takes you to the OpenTelemetry community repository on GitHub. | ||
|
|
||
| Start with the New Contributor Guide. | ||
|
|
||
| Before contributing code, you'll want to review a few prerequisites, including creating a GitHub account, signing the Contributor License Agreement, and reading the Code of Conduct. | ||
|
|
||
| The contributor guide also explains how the community works and where to find more detailed contribution instructions. | ||
|
|
||
| --- | ||
|
|
||
| ## 3. Finding the OpenTelemetry GitHub Community (~45 sec) | ||
|
|
||
| **On screen:** Open the `open-telemetry/community` repository. Scroll through the README and highlight **Get Involved**. | ||
|
|
||
| **Narration:** | ||
|
|
||
| This is the OpenTelemetry community repository. It's where the project keeps its governance docs, its SIG list, and its meeting calendar. | ||
|
anarwal marked this conversation as resolved.
Outdated
|
||
|
|
||
| The "Get Involved" section lists three next steps: | ||
|
|
||
| First, read the contributor guide. | ||
|
|
||
| Second, join Slack and community meetings. | ||
|
|
||
| And third, if you already know which part of OpenTelemetry interests you, find its Special Interest Group, or SIG. | ||
|
|
||
| Almost everything in the project is organized by SIG, so that's next. | ||
|
|
||
| --- | ||
|
|
||
| ## 4. What Is a SIG? (~60 sec) | ||
|
|
||
| **On screen:** Navigate to the OpenTelemetry SIG list in `community/sigs.md`. Scroll through several SIGs and show the columns for meetings, Slack channels, and repositories. | ||
|
|
||
| **Narration:** | ||
|
|
||
| SIG stands for **Special Interest Group**. | ||
|
|
||
| OpenTelemetry is a large project, so the community is organized into SIGs focused on different parts of the project. | ||
|
|
||
| There are SIGs for specific implementations and languages, as well as cross-cutting areas such as security, documentation, contributor experience, and developer experience. | ||
|
|
||
| For each group, the SIG list gives you the meeting schedule, meeting notes, Slack channel, repositories, and who to contact. | ||
|
|
||
| SIG meetings are open to anyone, so sitting in on a meeting or its Slack channel lets you see what a group is working on before you pick something up. | ||
|
|
||
| Choose the SIG that most closely matches the area where you'd like to contribute. | ||
|
|
||
| --- | ||
|
|
||
| ## 5. Joining Slack (~60 sec) | ||
|
|
||
| **On screen:** Return to the community README → Slack section. Show the CNCF Slack signup link and the listed OpenTelemetry channels. | ||
|
|
||
| **Narration:** | ||
|
|
||
| OpenTelemetry doesn't run its own Slack workspace. It uses the **CNCF** Slack — the Cloud Native Computing Foundation's shared workspace. | ||
|
|
||
| If you aren't already a member, follow the signup link from the OpenTelemetry community page to create your CNCF Slack account. | ||
|
|
||
| Once you're there, start in `#opentelemetry-new-contributors`. It's the channel set up specifically for people making their first contribution. There's also a general `#opentelemetry` channel. | ||
|
|
||
| Most SIGs have their own Slack channel as well. You can find the appropriate channel directly from the SIG list we looked at earlier. | ||
|
|
||
| These channels are where you can ask questions and reach the people maintaining the area you're interested in. | ||
|
|
||
| --- | ||
|
|
||
| ## 6. Finding a Good First Issue (~60 sec) | ||
|
|
||
| **On screen:** Open an OpenTelemetry GitHub repository. Navigate to **Contribute** and/or **Issues**. Show issues carrying the `good first issue` label. | ||
|
|
||
| **Narration:** | ||
|
|
||
| Once you've picked an area, open its repository and go to the **Contribute** tab or the issue list. | ||
|
kaylareopelle marked this conversation as resolved.
Outdated
|
||
|
|
||
| Many repositories tag beginner-friendly work with the `good first issue` label, and GitHub's Contribute tab collects those in one place. Not every repository uses it, so if the tab is empty, check the issue list directly. | ||
|
maryliag marked this conversation as resolved.
Outdated
|
||
|
|
||
| Before starting work, read the repository's `CONTRIBUTING.md` because contribution processes can differ between repositories. | ||
|
|
||
| Also read the issue discussion and check whether someone is already working on it. | ||
|
|
||
| If you're unsure whether an issue is a good fit, reach out through the relevant SIG or Slack channel before you start. | ||
|
kaylareopelle marked this conversation as resolved.
Outdated
|
||
|
|
||
| --- | ||
|
|
||
| ## 7. Wrap-Up (~30 sec) | ||
|
|
||
| **On screen:** Briefly revisit the community repository or show a simple path: | ||
|
|
||
| `opentelemetry.io → Contributor Guide → SIG → Slack → GitHub Issue` | ||
|
|
||
| **Narration:** | ||
|
|
||
| That's the basic path for getting started: | ||
|
|
||
| Start at OpenTelemetry.io. | ||
|
|
||
| Read the contributor guide. | ||
|
|
||
| Find a SIG related to your interests. | ||
|
|
||
| Join the CNCF Slack community and the relevant SIG channel. | ||
|
|
||
| Then find a good first issue and connect with the community before you start working on it. | ||
|
|
||
| And remember: contributing doesn't only mean writing code. Documentation, issue triage, community work, reviews, and other contributions all help OpenTelemetry grow. | ||
|
anarwal marked this conversation as resolved.
Outdated
|
||
|
|
||
| Welcome to the OpenTelemetry community. We hope to see you contributing. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.