From 9dc352859402b844d171d32073dc9570f2754dcb Mon Sep 17 00:00:00 2001 From: Christian Nunciato Date: Thu, 20 Jul 2023 07:21:37 -0700 Subject: [PATCH] Update the blog archetype (#3170) --- BLOGGING.md | 2 +- themes/default/archetypes/blog-post/index.md | 60 +++++++++----------- 2 files changed, 27 insertions(+), 35 deletions(-) diff --git a/BLOGGING.md b/BLOGGING.md index f5682e8e1..822160a16 100644 --- a/BLOGGING.md +++ b/BLOGGING.md @@ -195,7 +195,7 @@ gifsicle ./my-animation.gif --resize-width=1200 --optimize=3 --batch ## Done? Submit! -When you're ready to submit your post for review, issue a Pull Request against the `master` branch of the repo, and the team will have a look. Once merged — provided its `date` has passed the post will be deployed to https://www.pulumi.com/. +When you're ready to submit your post for review, issue a Pull Request against the `master` branch of the repo, and the team will have a look. Once merged, the post will be deployed to https://www.pulumi.com/. ## Publicize your blog diff --git a/themes/default/archetypes/blog-post/index.md b/themes/default/archetypes/blog-post/index.md index 768f9309a..dd0dd8c2e 100644 --- a/themes/default/archetypes/blog-post/index.md +++ b/themes/default/archetypes/blog-post/index.md @@ -1,62 +1,54 @@ --- title: "{{ replace .Name "-" " " | title }}" -# The date represents the post's publish date, -# and by default corresponds with the date this file was generated. -# Posts with future dates are visible in development, -# but excluded from production builds. -# Use the time and timezone-offset portions of of this value -# to schedule posts for publishing later. +# The date represents the post's publish date, and by default corresponds with +# the date and time this file was generated. Dates are used for display and +# ordering purposes only; they have no effect on whether or when a post is +# published. To influence the ordering of posts published on the same date, use +# the time portion of the date value; posts are sorted in descending order by +# date/time. date: {{ .Date }} -# Use the meta_desc property to provide a brief summary -# (one or two sentences) of the content of the post, -# which is useful for targeting search results or social-media previews. -# This field is required or the build will fail the linter test. -# Max length is 160 characters. +# The draft setting determines whether a post is published. Set it to true if +# you want to be able to merge the post without publishing it. +draft: false + +# Use the meta_desc property to provide a brief summary (one or two sentences) +# of the content of the post, which is useful for targeting search results or +# social-media previews. This field is required or the build will fail the +# linter test. Max length is 160 characters. meta_desc: -# The meta_image appears in social-media previews and on the blog home page. -# A placeholder image representing the recommended format, dimensions and aspect ratio -# has been provided for you. +# The meta_image appears in social-media previews and on the blog home page. A +# placeholder image representing the recommended format, dimensions and aspect +# ratio has been provided for you. meta_image: meta.png -# At least one author is required. -# The values in this list correspond with the `id` properties -# of the team member files at /data/team/team. -# Create a file for yourself if you don't already have one. +# At least one author is required. The values in this list correspond with the +# `id` properties of the team member files at /data/team/team. Create a file for +# yourself if you don't already have one. authors: - joe-duffy -# At least one tag is required. -# Lowercase, hyphen-delimited is recommended. +# At least one tag is required. Lowercase, hyphen-delimited is recommended. tags: - change-me -# See the blogging docs at https://github.com/pulumi/pulumi-hugo/blob/master/BLOGGING.md. -# for additional details, -# and please remove these comments before submitting for review. +# See the blogging docs at https://github.com/pulumi/pulumi-hugo/blob/master/BLOGGING.md +# for details, and please remove these comments before submitting for review. --- -What you put here will appear on the index page. -In most cases, you'll also want to add a Read More link after this paragraph -(though technically, that's optional). -To do that, just add an HTML comment like the one below. +What you put here will appear on the index page. In most cases, you'll also want to add a Read More link after this paragraph (though technically, that's optional. To do that, just add an HTML comment like the one below. And then everything _after_ that comment will appear on the post page itself. -Either way, avoid using images or code samples -[in the first 70 words](https://gohugo.io/content-management/summaries/#automatic-summary-splitting) of your post, -as these may not render properly in summary contexts (e.g., on the blog home page or in social-media previews). +Either way, avoid using images or code samples [in the first 70 words](https://gohugo.io/content-management/summaries/#automatic-summary-splitting) of your post, as these may not render properly in summary contexts (e.g., on the blog home page or in social-media previews). ## Writing the Post -For help assembling the content of your post, -see [BLOGGING.md](https://github.com/pulumi/pulumi-hugo/blob/master/BLOGGING.md). -For general formatting guidelines, -see the [Style Guide](https://github.com/pulumi/pulumi-hugo/blob/master/STYLE-GUIDE.md). +For help assembling the content of your post, see [BLOGGING.md](https://github.com/pulumi/pulumi-hugo/blob/master/BLOGGING.md). For general formatting guidelines, see the [Style Guide](https://github.com/pulumi/pulumi-hugo/blob/master/STYLE-GUIDE.md). ## Code Samples