Skip to content

Commit 601a4d0

Browse files
authored
Merge pull request #4785 from FlowFuse/changelog-fixes
Fix relative links, cross-link project-management, align AI prompt
2 parents 6fdeedd + 783863d commit 601a4d0

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

src/handbook/engineering/project-management.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ If questions, issues, or improvement ideas come up during a demo, they should be
154154

155155
Some completed work is communicated externally via the FlowFuse changelog and release highlights.
156156

157+
For detailed guidance on writing changelog posts, see [Writing Changelog Posts](/handbook/engineering/releases/writing-changelog/).
158+
157159
Work may be changelog-worthy when it:
158160

159161
* delivers visible user value

src/handbook/engineering/releases/writing-changelog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Paste the following prompt into your tool of choice along with your PR descripti
181181
> - Focuses on what the user can now do (use “you” where possible)
182182
> - Explains the user benefit in one or two sentences
183183
> - Includes a 'getting started' section only if the user needs to take action
184-
> - Ends with: "This change is live on FlowFuse Cloud. Self Hosted users will receive it in the next release (vX.Y)."
184+
> - Ends with an availability note: "This feature is available to [tier] users of FlowFuse Cloud and [licence type] Self Hosted users from vX.Y."
185185
>
186186
> Do not use PR titles or commit message language. Write for someone who just opened FlowFuse and wants to know what’s new.
187187
>
@@ -197,7 +197,7 @@ Always review and edit the output before publishing.
197197
>
198198
> It is a small (but important) improvement that just makes things that little bit easier.
199199

200-
*Source: [Duplicate Instances Across Different Applications](https://flowfuse.com/changelog/2025/10/duplicate-instances-across-applications/)*
200+
*Source: [Duplicate Instances Across Different Applications](/changelog/2025/10/duplicate-instances-across-applications/)*
201201

202202
Short, honest about the size of the change, and gets straight to the point.
203203

@@ -210,7 +210,7 @@ Short, honest about the size of the change, and gets straight to the point.
210210
> - Are any nodes on my palette disabled?
211211
> - Can you suggest a node package that would replace this complex function code?
212212

213-
*Source: [FlowFuse Expert: Palette Queries](https://flowfuse.com/changelog/2026/01/ff-expert-palette-queries/)*
213+
*Source: [FlowFuse Expert: Palette Queries](/changelog/2026/01/ff-expert-palette-queries/)*
214214

215215
Instead of describing the feature abstractly, this shows exactly how a user will interact with it. Use this approach whenever concrete examples best explain a feature — what the user can now say or do.
216216

@@ -220,7 +220,7 @@ Instead of describing the feature abstractly, this shows exactly how a user will
220220
>
221221
> This feature is available to Enterprise Licensed Self Hosted users and Enterprise tier users of FlowFuse Cloud.
222222

223-
*Source: [HA Hosted Instance Rolling Restart](https://flowfuse.com/changelog/2026/02/ha-instance-rolling-restart/)*
223+
*Source: [HA Hosted Instance Rolling Restart](/changelog/2026/02/ha-instance-rolling-restart/)*
224224

225225
The technical detail is there, but the sentence that follows immediately translates it into what the user actually cares about. Always pair the *what* with the *so what*.
226226

@@ -232,7 +232,7 @@ The technical detail is there, but the sentence that follows immediately transla
232232
>
233233
> To check your current version, run `node --version`.
234234

235-
*Source: [Node.js v20 Minimum Version Requirement](https://flowfuse.com/changelog/2025/11/minimum-nodejs-version/)*
235+
*Source: [Node.js v20 Minimum Version Requirement](/changelog/2025/11/minimum-nodejs-version/)*
236236

237237
State what is changing and who it affects in the first sentence. Then explain why. Then tell the user exactly what to do. A user who needs to act should have everything they need without leaving the page.
238238

0 commit comments

Comments
 (0)