Skip to content

Commit 7aabb11

Browse files
committed
Proposed hugo archetype to fix issue #27843
1 parent 2b38c75 commit 7aabb11

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

archetypes/blog-post.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: blog
3+
title: "{{ replace .Name "-" " " | title }}"
4+
date: {{ .Date }}
5+
draft: true
6+
slug: <seo-friendly-version-of-title-separated-by-dashes>
7+
---
8+
9+
**Author:** <your name> (<your organization name>), <another author's name> (<their organization>)
10+
11+
<!--
12+
Instructions:
13+
- Replace these instructions and the following text with your content.
14+
- Replace `<angle bracket placeholders>` with actual values. For example, you would update `date: <yyyy>-<mm>-<dd>` to look something like `date: 2021-10-21`.
15+
- For convenience, use third-party tools to author and collaborate on your content.
16+
- To save time and effort in reviews, check your content's spelling, grammar, and style before contributing.
17+
- Feel free to ask for assistance in the Kubernetes Slack channel, [#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J).
18+
-->
19+
20+
Replace this first line of your content with one to three sentences that summarize the blog post.
21+
22+
## This is a section heading
23+
24+
To help the reader, organize your content into sections that contain about three to six paragraphs.
25+
26+
If you're documenting commands, separate the commands from the outputs, like this:
27+
28+
1. Verify that the Secret exists by running the following command:
29+
30+
```shell
31+
kubectl get secrets
32+
```
33+
34+
The response should be like this:
35+
36+
```shell
37+
NAME TYPE DATA AGE
38+
mysql-pass-c57bb4t7mf Opaque 1 9s
39+
```
40+
41+
You're free to create any sections you like. Below are a few common patterns we see at the end of blog posts.
42+
43+
## What’s next?
44+
45+
This optional section describes the future of the thing you've just described in the post.
46+
47+
## How can I learn more?
48+
49+
This optional section provides links to more information. Please avoid promoting and over-represent your organization.
50+
51+
## How do I get involved?
52+
53+
An optional section that links to resources for readers to get involved, and acknowledgments of individual contributors, such as:
54+
55+
* [The name of a channel on Slack, #a-channel](https://<a-workspace>.slack.com/messages/<a-channel>)
56+
57+
* [A link to a "contribute" page with more information](<https://github.com/kubernetes/community/blob/master/sig-storage/README.md#contact>).
58+
59+
* Acknowledgements and thanks to the contributors. <person's name> ([<github id>](https://github.com/<github id>)) who did X, Y, and Z.
60+
61+
* Those interested in getting involved with the design and development of <project>, join the [<name of the SIG>](https://github.com/project/community/tree/master/<sig-group>). We’re rapidly growing and always welcome new contributors.

0 commit comments

Comments
 (0)