@@ -6,13 +6,25 @@ weight: 30
6
6
7
7
The [OpenTelemetry blog](/blog/) communicates new features, community reports,
8
8
and any news that might be relevant to the OpenTelemetry community. This
9
- includes end users and developers. Anyone can write a blog post and submit it
10
- for review.
9
+ includes end users and developers. Anyone can write a blog post, read below what
10
+ the requirements are.
11
+
12
+ ## Documentation or blog post?
13
+
14
+ Before writing a blog post, ask yourself if your content also might be a good
15
+ addition to the documentation. If the answer is "yes", create a new issue or
16
+ pull request (PR) with your content to get it added to the docs.
17
+
18
+ Note, that the focus of maintainers and approvers of the OpenTelemetry Website
19
+ is to improve the documentation of the project, so your blog post will have a
20
+ lower priority for review.
11
21
12
22
## Before submitting a blog post
13
23
14
24
Blog posts should not be commercial in nature and should consist of original
15
- content that applies broadly to the OpenTelemetry community.
25
+ content that applies broadly to the OpenTelemetry community. Blog posts should
26
+ follow the policies outlined in the
27
+ [Social Media Guide](https://github.com/open-telemetry/community/blob/main/social-media-guide.md).
16
28
17
29
Verify that your intended content broadly applies to the OpenTelemetry Community
18
30
. Appropriate content includes:
@@ -27,15 +39,28 @@ Unsuitable content includes:
27
39
28
40
- Vendor product pitches
29
41
30
- To submit a blog post,
42
+ If your blog post fits into the list of appropriate content ,
31
43
[raise an issue](https://github.com/open-telemetry/opentelemetry.io/issues/new?title=New%20Blog%20Post:%20%3Ctitle%3E)
32
- with the title and a short description of your blog post. If you are not a
33
- [Member](https://github.com/open-telemetry/community/blob/main/community-membership.md#member),
34
- you also need to provide a _sponsor_ for your blog post, who is a Member (by
35
- that definition) and who is willing to provide a first review of your blog post.
36
-
37
- If you do not raise an issue before providing your PR, we may request you to do
38
- so before providing a review.
44
+ with the following details:
45
+
46
+ - Title of the blog post
47
+ - Short description and outline of your blog post
48
+ - If applicable, list the technologies used in your blog post. Make sure that
49
+ all of them are open source, and prefer CNCF projects over non-CNCF projects
50
+ (e.g. use Jaeger for trace visualization, and Prometheus for metric
51
+ visualization)
52
+ - Name of a [SIG](https://github.com/open-telemetry/community/), which is
53
+ related to this blog post
54
+ - Name of a sponsor (maintainer or approver) from this SIG, who will help to
55
+ review that PR
56
+
57
+ Maintainers of SIG Communication will verify, that your blog post satisfies all
58
+ the requirements for being accepted. If you can not name a SIG/sponsor in your
59
+ initial issue details, they will also point you to an appropriate SIG, you can
60
+ reach out to for sponsorship.
61
+
62
+ If your issue has everything needed, a maintainer will verify that you can go
63
+ ahead and submit your blog post.
39
64
40
65
## Submit a blog post
41
66
@@ -44,10 +69,6 @@ locally or by using the GitHub UI. In both cases we ask you to follow the
44
69
instructions provided by the
45
70
[blog post template](https://github.com/open-telemetry/opentelemetry.io/tree/main/archetypes/blog.md).
46
71
47
- **Note**: Before writing a blog post, ask yourself if your content also might be
48
- a good addition to the documentation. If the answer is "yes", create a new issue
49
- or pull request (PR) with your content to get it added to the docs.
50
-
51
72
### Fork and write locally
52
73
53
74
After you've set up the local fork you can create a blog post using a template.
0 commit comments