mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 10:59:59 +00:00
5.8 KiB
5.8 KiB
Release Articles
Write the blog article for a release, its banner image, and the Mastodon and LinkedIn posts that announce it. The article is one HTML file for a single WordPress Custom HTML block; the banner is a separate PNG for the post's Featured image and the image of both social posts.
Inputs
- The release version (for example
16.0) and its tag. When the.0tag was never published, the first published patch tag is the release tag and its upgrade notes count too. - The release sections of CHANGELOG.md.
- The latest article in the Release category of the blog, as the reference for length, tone and structure.
Output
- You MUST write every file to a work folder outside the repository and MUST NOT commit the article or the banner.
- The work folder holds
article.html,banner.svg,banner.png(1500 × 1000),banner-alt.txt,mastodon.txt,linkedin.txtandpost.md(title, category, tags).
Procedure
- Read the release sections of the changelog. Take the headline feature from the operator, otherwise the largest
Addedentry. Read the README of the role behind it so every claim is right. - Fetch the reference article and measure its body, from
<div class="inf-release">to its end: visible text characters (SVG icons excluded), words and markup lines. The new article MUST land within ±5 % on characters and on lines. - Copy templates/article.html and fill it in its order: badge; intro and a second paragraph; the warning (major releases only, otherwise drop the block); three feature cards; one or two sections on the headline feature with a bold-lead list; the callout; an optional "Also New" section; Before You Upgrade; More Reliable (three or four fixes); Updated Applications (about thirteen chips from the version jumps, major versions first); the closing section. Repeat card, list item, table row and chip blocks as needed and remove every
{{…}}placeholder. - Write every sentence to the standard below.
- Copy templates/banner.svg and fill it:
{{LOGO}}with thefile://URL of assets/img/logo.png,{{VERSION}}, two subtitle lines of at most 34 characters, four{{ICON_n}}(24 × 24 outline icons) and four{{LABEL_n}}(plain words, at most 14 characters) for the headline feature's benefits. - Render the banner with Playwright's headless shell (
~/.cache/ms-playwright/chromium_headless_shell-*/chrome-headless-shell-linux64/chrome-headless-shell) and the flags--disable-gpu --hide-scrollbars --allow-file-access-from-files --window-size=1500,1000 --screenshot=<work>/banner.png file://<work>/banner.svg. Look at the PNG and fix overlaps or cut text before you go on. - Write
banner-alt.txt(one to three sentences that describe the banner and repeat its title) and the two social posts to the Social Posts rules below, with{{ARTICLE_URL}}where the article link goes. - Verify: no
{{left in the article; no<code>, command, flag, path or variable in the visible text of the article or the posts; lengths within range on every platform; every number and version matches the changelog. Render the article on a dark page at about 860 px width and look at it. - Hand over the paths, the title, the category
Release, ten to twenty tags, and the steps: paste the wholearticle.htmlinto one WordPress Custom HTML block and setbanner.pngas the Featured image; once the article is live, replace{{ARTICLE_URL}}in both posts with its link and post them withbanner.pngand the alt text.
Writing Standard
The article, the banner alt text and both social posts follow this standard. Their readers are outside the project, so deep technical detail stays out.
- Feature-oriented: say what the reader gets and why it matters, not how it is built.
- No commands, flags, file paths, variable names, role names, inventory keys or code, and no
<code>tags. Product names, application names and version numbers are fine. - Second person ("your servers"), present tense, short sentences, American English.
- Every claim MUST trace back to the changelog or to the README of the role behind it. No invented numbers, benefits or comparisons. Beta features say "beta".
- Section titles name a benefit ("A Private Network Between Your Servers"); list items open with a bold benefit lead.
- Before You Upgrade keeps every upgrade note of the changelog and phrases the action the reader takes, not the mechanism behind it.
Social Posts
Both posts follow the Writing Standard like the article: no commands, role names or deep technical detail, only what the reader gets. They lead with the headline feature and carry the banner with its alt text.
- Mastodon (
mastodon.txt): at most 500 characters, counting the link as 23. An opening line naming the release, two or three sentences on the headline feature, one line on the rest of the release, a pointer to the upgrade notes, the link, then three to five CamelCase hashtags (#InfinitoNexus,#SelfHosting,#OpenSource, plus the headline technology). At most two emoji; plain and direct, no marketing superlatives. - LinkedIn (
linkedin.txt): 1,000 to 1,600 characters. A hook in the first line of at most 200 characters, since LinkedIn shows only the first lines before "see more"; then short paragraphs: what the headline feature gives an organization, three benefit lines each opened by one emoji, one paragraph on the rest of the release, the upgrade pointer, the link, and three to five hashtags. Professional tone, second person, no hype words.
Rules
- You MUST NOT publish to, or sign in to, the blog, Mastodon or LinkedIn. The operator publishes.
- You MUST NOT add the banner to the article HTML; it belongs in the Featured image.