From 4dcb271c76825320c1523a143a4155a1dbc729e6 Mon Sep 17 00:00:00 2001 From: Dimitrie Hoekstra Date: Mon, 26 Jan 2026 17:03:24 +0100 Subject: [PATCH] Document PR preview deployment URLs in handbook Add documentation for PR preview deployment URLs across three handbook sections to help team members find and use preview links when reviewing changes: - Git guide: For all staff, explains where to find preview URLs for both FlowFuse/website (Netlify bot comments) and FlowFuse/flowfuse (#gh-pipelines) - Marketing/Website: For marketing team reviewing website content changes - Development/Project Management: For engineers reviewing product changes All repository references include direct GitHub links for easy navigation. --- src/handbook/company/guides/git.md | 9 +++++++++ src/handbook/development/project-management.md | 4 ++++ src/handbook/marketing/website.md | 4 ++++ 3 files changed, 17 insertions(+) diff --git a/src/handbook/company/guides/git.md b/src/handbook/company/guides/git.md index f98283c439..c333d25b3c 100644 --- a/src/handbook/company/guides/git.md +++ b/src/handbook/company/guides/git.md @@ -108,6 +108,15 @@ Once you press the 'Create pull request' button an alert will be sent to one of ![Request a review from a specific colleague](../../images/git-how-to/nominate-a-reviewer-1.gif "@skip") +#### Preview URLs + +After creating a Pull Request, you can preview your changes before they go live: + +- **[FlowFuse/website](https://github.com/FlowFuse/website)**: Look for the Netlify bot comment on your PR with a preview link +- **[FlowFuse/flowfuse](https://github.com/FlowFuse/flowfuse)**: Preview URLs are posted to the [`#gh-pipelines`](https://flowfuse.slack.com/archives/C067BD0377F) Slack channel + +These preview links let you and your reviewer see exactly how your changes will look. + ### Requesting a review of your work Once a colleague has [reviewed](#review) your work you will receive an email alert. They can provide feedback on your work in three ways, sometimes a [review](#review) will include more than one type of feedback. diff --git a/src/handbook/development/project-management.md b/src/handbook/development/project-management.md index 449be261f5..ecac6818df 100644 --- a/src/handbook/development/project-management.md +++ b/src/handbook/development/project-management.md @@ -285,6 +285,10 @@ The board has the following states: - `Review` - items that are ready to be reviewed (PR open & [feature demo](#feature-demos) created) - `Done` - items that are [Done](#defining-done) +##### PR Preview Deployments + +PRs to the [FlowFuse/flowfuse](https://github.com/FlowFuse/flowfuse) repository automatically receive preview deployment URLs posted to the [`#gh-pipelines`](https://flowfuse.slack.com/archives/C067BD0377F) Slack channel. Use these to test changes in a live environment during review. + ##### In Design Deliverables Both UX/UI work and engineering work can be "In Design". For both instances there should still be defined deliverables. diff --git a/src/handbook/marketing/website.md b/src/handbook/marketing/website.md index 681db8f3ab..fa5880fa06 100644 --- a/src/handbook/marketing/website.md +++ b/src/handbook/marketing/website.md @@ -111,3 +111,7 @@ When creating a PR and requesting a review from a FlowFuse team member, please c the content is ready to be released ASAP or if its release should be to a particular schedule. If you don't want the reviewer to merge the content (in effect put it live on the website) mark the PR as a draft in GitHub. If you are reviewing a website PR and it is not marked as draft you can merge it, otherwise simply review and where appropriate approve the PR. + +### Preview URLs + +[FlowFuse/website](https://github.com/FlowFuse/website) PRs automatically receive Netlify preview deployment URLs. Look for the Netlify bot comment on the PR with the preview link to review your changes before merging.