diff --git a/docs/img/pr-checks.png b/docs/img/pr-checks.png new file mode 100644 index 0000000000..08d441c19d Binary files /dev/null and b/docs/img/pr-checks.png differ diff --git a/docs/pr-previews.md b/docs/pr-previews.md new file mode 100644 index 0000000000..cc71b41483 --- /dev/null +++ b/docs/pr-previews.md @@ -0,0 +1,32 @@ +# Pull Request Previews + +Pull requests to the React SDK layer (and in the future other layers as well) +automatically set up a preview site with a full deployment of Element with the +changes from the pull request added in so that anyone can easily test and review +them. This is especially useful for checking visual and interactive changes. + +To access the preview site, scroll down to the bottom of the PR where the +various CI results are displayed: + +![Pull request: checks section](./img/pr-checks.png) + +The checks section could be collapsed at first, so you may need to click "Show +all checks" to reveal them. Look for an entry that mentions `deploy-preview`. It +may be at the end of the list, so you may need scroll a bit to see it. To access +the preview site, click the "Details" link in the deploy preview row. + +**Important:** Please always use test accounts when logging into preview sites, +as they may contain bugs or other issues that could damage your account. + +## FAQs + +### Are preview sites created for pull requests from contributors? + +Yes, they are created for all PRs from any author. + +### Do preview sites expire after some time period? + +No, there is no expiry date, so they should remain accessible indefinitely, but +of course they obviously aren't meant to live beyond the development workflow, +so please don't rely on them for anything important. They may disappear at any +time without notice. diff --git a/docs/review.md b/docs/review.md index 75fd77704a..c08ab10818 100644 --- a/docs/review.md +++ b/docs/review.md @@ -73,10 +73,9 @@ functionality is: required (though may still be useful) since we can continue tweaking As it can be difficult to review design work from looking at just the changed -files in a PR, authors should be prepared for Design and / or Product teams to -request a link to an ad-hoc build of Element (hosted anywhere) that can be used for -the review. In the future, we [hope to automate -this](https://github.com/vector-im/element-web/issues/12624) for every PR. +files in a PR, a [preview site](./pr-previews.md) that includes your changes +will be added automatically so that anyone who's interested can try them out +easily. Before starting work on a feature, it's best to ensure your plan aligns well with our vision for Element. Please chat with the team in