search

pulumi / docs

All things Pulumi docs!
https://pulumi.com
Apache License 2.0
128 stars 222 forks source link

document key content design considerations for blogs #11702

Open susanev opened 2 years ago

susanev commented 2 years ago

overivew

was chatting with @SaraDPH about content design and our blogs. i think it would be good to document what folks should keep in mind when writing blogs, e.g, if a video is included it should be near the top of the blog, keep paragraphs to 8 sentences or less, use lists when providing instructional directions, etc.

we could add this information to https://github.com/pulumi/pulumi-hugo/blob/master/BLOGGING.md or https://github.com/pulumi/pulumi-hugo/blob/master/STYLE-GUIDE.md or some other place, then maybe also include it in the pr template for blogs (if we have one)

susanev commented 2 years ago

@cnunciato @SaraDPH tagging yall so you know this issue is here, feel free to use it or close it if yall have another one for this.

cnunciato commented 2 years ago

This is good for tracking it -- thanks @susanev!