Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section for release posts #51

Merged
merged 2 commits into from
Oct 1, 2019
Merged

Add section for release posts #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cbbb48
Add section of release posts
meichstedt Sep 30, 2019
669d58b
Add template for release blog posts
meichstedt Sep 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions content/internal-docs/blog-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,22 @@ In order to keep previews slim, any headers within the excerpt will be hidden, a
Posts will be sorted according to their date. In order to find easily tell apart release announcements from other posts, please follow the following naming convention:
- **Release announcements**: `announcing-kudo-<version>.md`
- **Other blog posts**: `blog-YYYY-MM-<name>.md`

## Release Posts

A blog post that notifies of a release should follow this format:

- The title should be _Announcing KUDO x.y.z_
- The first paragraph should summarize the high level additions in this release and must be followed by an html comment line:
```
<!-- more -->
```
This will use this forst paragraph as an excerpt for rendering the blog posts overview and rss feed summary.
- The following content should be copied/pasted from the Github release page
- The blog post should close with a link to the changelog and ideally an overview of the next release.

You can find a template [here](https://raw.githubusercontent.com/kudobuilder/www/master/content/internal-docs/release-post-template.md).

::: warning Link Your Post
We haven't added a dynamic sidebar yet so each blog post must be manually added to the blog section of the sidebar in [config.js](https://github.com/kudobuilder/www/blob/0a160e629e21593a10e5fa1bb18353ddf1c34d2b/content/.vuepress/config.js#L80-L83).
:::
24 changes: 24 additions & 0 deletions content/internal-docs/release-post-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
date: YYYY-MM-DD
---

# Announcing KUDO $VERSION$

This paragraph should describe the added functionality in this release in one to three sentences.

<!-- more -->

## Release Highlights

Copy the Github release page in here with h3 headers

## Changelog

To see the full changelog and the list of contributors who contributed to this release, visit [the Github Release](https://github.com/kudobuilder/kudo/releases/tag/$VERSION$) page.

## What's Next?

If possible, point out roughly what the next release is going to bring.
See the [KUDO Roadmap](https://github.com/orgs/kudobuilder/projects/2) for details.

[Get started](../docs/README.md) with KUDO today. Our [community](../community/README.md) is ready for feedback to make KUDO even better!