Skip to content

Commit 8caeb13

Browse files
authored
Add some instructions for new comers to README.md (open-telemetry#1687)
* Add some instructions for new comers to README.md Signed-off-by: svrnm <[email protected]> * Add some instructions for new comers to README.md, 2 Signed-off-by: svrnm <[email protected]> Signed-off-by: svrnm <[email protected]>
1 parent 28bb5b4 commit 8caeb13

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

README.md

+40-19
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> OpenTelemetry.io
22

3-
This is the source repo for the [OpenTelemetry][] website and project
4-
documentation. The site is [built][contributing.md] using [Hugo][] and hosted on
3+
This is the source repo for the [OpenTelemetry][] website, project documentation
4+
and blog. The site is [built][contributing.md] using [Hugo][] and hosted on
55
[Netlify][].
66

7+
## Get involved
8+
9+
If you are new to OpenTelemetry and just get started with it, you are in a
10+
perfect position to help us get better: the website and documentation is the
11+
entry point for newcomers like you, so if something is unclear or something is
12+
missing [let us know][]!
13+
14+
Read on to learn about other ways on how you can help.
15+
716
## Adding a project to the OpenTelemetry Registry
817

918
Do you maintain or contribute to an integration for OpenTelemetry? We'd love to
@@ -15,9 +24,9 @@ file in `/content/en/registry` for your project. You can find a template in
1524

1625
## Submitting a blog post
1726

18-
You can submit a blog post either by forking this repository and writting it locally
19-
or by using the GitHub UI. In both cases we ask you to follow the instructions provided
20-
by the [blog post template](archetypes/blog.md)
27+
You can submit a blog post either by forking this repository and writting it
28+
locally or by using the GitHub UI. In both cases we ask you to follow the
29+
instructions provided by the [blog post template](archetypes/blog.md)
2130

2231
### Fork & Write locally
2332

@@ -35,24 +44,26 @@ request][pr].
3544

3645
### Using the Github UI
3746

38-
* Go to the [blog post template](archetypes/blog.md) and click on `Copy raw content` at the top right of the menu
39-
* [Create a new file](https://github.com/open-telemetry/opentelemetry.io/new/main)
40-
* Paste the content from the template
41-
* Start editing the markdown file
42-
* Once your post is ready click on `Propose changes` at the bottom.
47+
- Go to the [blog post template](archetypes/blog.md) and click on
48+
`Copy raw content` at the top right of the menu
49+
- [Create a new file](https://github.com/open-telemetry/opentelemetry.io/new/main)
50+
- Paste the content from the template
51+
- Start editing the markdown file
52+
- Once your post is ready click on `Propose changes` at the bottom.
4353

4454
## Contributing
4555

4656
See [CONTRIBUTING.md][].
4757

48-
We (OTel Comms SIG) meet every two weeks on Thursdays at 10:30 PT.
49-
Check out the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com)
50-
for the Zoom link and any updates to this schedule.
58+
We have curated some issues with the tags [help wanted][] and [good first
59+
issue][]. This should allow you to quickly find a place to contribute
5160

52-
Meeting notes are available as a public [Google
53-
doc](https://docs.google.com/document/d/1wW0jLldwXN8Nptq2xmgETGbGn9eWP8fitvD5njM-xZY/edit?usp=sharing).
54-
If you have trouble accessing the doc, please get in touch on
55-
[Slack](https://cloud-native.slack.com/archives/C02UN96HZH6).
61+
We (OTel Comms SIG) meet every two weeks on Thursdays at 10:30 PT. Check out the
62+
[OpenTelemetry community calendar][] for the Zoom link and any updates to this
63+
schedule.
64+
65+
Meeting notes are available as a public [Google doc][]. If you have trouble
66+
accessing the doc, please get in touch on [Slack][].
5667

5768
Roles:
5869

@@ -68,6 +79,8 @@ already contributed][contributors]!
6879
- Documentation: [CC-BY-4.0](LICENSE)
6980
- Code: [Apache-2.0](LICENSE-CODE)
7081

82+
[let us know]:
83+
https://github.com/open-telemetry/opentelemetry.io/issues/new/choose
7184
[@open-telemetry/blog-approvers]:
7285
https://github.com/orgs/open-telemetry/teams/blog-approvers
7386
[@open-telemetry/docs-approvers]:
@@ -85,6 +98,14 @@ already contributed][contributors]!
8598
[pr]:
8699
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
87100
[registry]: https://opentelemetry.io/registry/
88-
[blog post template for editing]:
101+
[opentelemetry community calendar]:
102+
https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com
103+
[help wanted]:
104+
https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
105+
[good first issue]:
106+
https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
107+
[google doc]:
108+
https://docs.google.com/document/d/1wW0jLldwXN8Nptq2xmgETGbGn9eWP8fitvD5njM-xZY/edit?usp=sharing
109+
[slack]: https://cloud-native.slack.com/archives/C02UN96HZH6
110+
[blog post template for editing]:
89111
https://github.com/open-telemetry/opentelemetry.io/edit/main/archetypes/blog.md
90-

0 commit comments

Comments
 (0)