Skip to content

Commit 044fd99

Browse files
authored
add 'read more' marker instruction to blog guidelines (#2767)
Signed-off-by: Victoria Nduka <[email protected]>
1 parent 1189f16 commit 044fd99

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

blog/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,29 @@ and 1500 words (like [this long deep dive](https://prometheus.io/blog/2021/11/16
4646
If you include code snippets or configuration examples, please make sure they work as written.
4747
Diagrams or screenshots are also great additions if they help readers grasp complex ideas more quickly.
4848

49-
When multiple people contribute to a post, we’ll make sure everyone is credited at the end.
49+
When multiple people contribute to a post, we’ll make sure everyone is credited at the end.
5050

51+
> [!IMPORTANT]
52+
> After your introductory section, add a `<!-- more -->` marker on its own line.
53+
This marker indicates where the preview cuts off on https://prometheus.io/blog/. See the example below.
54+
55+
**Example structure:**
56+
```markdown
57+
---
58+
title: "Getting Started with Prometheus"
59+
author: Your Name (@yourgithubusername)
60+
date: 2025-11-02
61+
---
62+
63+
Prometheus makes it easy to collect and query metrics from your applications. In this post, we'll walk through
64+
setting up your first metrics endpoint and understanding what Prometheus collects.
65+
66+
<!-- more -->
67+
68+
## Installing Prometheus
69+
70+
First, let's get Prometheus installed on your system...
71+
```
5172

5273
## Review process
5374

0 commit comments

Comments
 (0)