forked from kubernetes/website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Proposed hugo archetype to fix issue kubernetes#27843
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,61 @@ | ||
--- | ||
layout: blog | ||
title: "{{ replace .Name "-" " " | title }}" | ||
date: {{ .Date }} | ||
draft: true | ||
slug: <seo-friendly-version-of-title-separated-by-dashes> | ||
--- | ||
|
||
**Author:** <your name> (<your organization name>), <another author's name> (<their organization>) | ||
|
||
<!-- | ||
Instructions: | ||
- Replace these instructions and the following text with your content. | ||
- Replace `<angle bracket placeholders>` with actual values. For example, you would update `date: <yyyy>-<mm>-<dd>` to look something like `date: 2021-10-21`. | ||
- For convenience, use third-party tools to author and collaborate on your content. | ||
- To save time and effort in reviews, check your content's spelling, grammar, and style before contributing. | ||
- Feel free to ask for assistance in the Kubernetes Slack channel, [#sig-docs-blog](https://kubernetes.slack.com/archives/CJDHVD54J). | ||
--> | ||
|
||
Replace this first line of your content with one to three sentences that summarize the blog post. | ||
|
||
## This is a section heading | ||
|
||
To help the reader, organize your content into sections that contain about three to six paragraphs. | ||
|
||
If you're documenting commands, separate the commands from the outputs, like this: | ||
|
||
1. Verify that the Secret exists by running the following command: | ||
|
||
```shell | ||
kubectl get secrets | ||
``` | ||
|
||
The response should be like this: | ||
|
||
```shell | ||
NAME TYPE DATA AGE | ||
mysql-pass-c57bb4t7mf Opaque 1 9s | ||
``` | ||
|
||
You're free to create any sections you like. Below are a few common patterns we see at the end of blog posts. | ||
## What’s next? | ||
This optional section describes the future of the thing you've just described in the post. | ||
|
||
## How can I learn more? | ||
|
||
This optional section provides links to more information. Please avoid promoting and over-represent your organization. | ||
|
||
## How do I get involved? | ||
|
||
An optional section that links to resources for readers to get involved, and acknowledgments of individual contributors, such as: | ||
|
||
* [The name of a channel on Slack, #a-channel](https://<a-workspace>.slack.com/messages/<a-channel>) | ||
|
||
* [A link to a "contribute" page with more information](<https://github.com/kubernetes/community/blob/master/sig-storage/README.md#contact>). | ||
|
||
* Acknowledgements and thanks to the contributors. <person's name> ([<github id>](https://github.com/<github id>)) who did X, Y, and Z. | ||
* 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. |