Skip to content

Commit

Permalink
Add images to PR preview part two post
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Dec 26, 2023
1 parent 300a3ce commit 2d90ca9
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
Binary file added content/assets/github-all-checks-have-passed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion content/posts/website-repo-pr-preview-part-2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Maybe your site isn't a docs site. That's OK. Publish your production site from
main branch to GitHub Pages with GitHub Actions if you feel that way! ReadTheDocs can
still provide convenient PR previews in that case.

In [Part 1 of this series](/posts/website-repo-pr-previews/index.md), I discussed why
In [Part 1 of this series](/posts/website-repo-pr-preview/index.md), I discussed why
we must look outside of GitHub Pages to solve this problem (when
[deploying as an artifact](https://github.com/orgs/community/discussions/30113#discussioncomment-7650234)).
ReadTheDocs, when used _only_ for PR previews, requires significantly less
Expand All @@ -60,6 +60,19 @@ I'm not happy with this. If you see ways to improve it, I'd love to hear from yo
issue or PR!


## :magnifying_glass: Findability

ReadTheDocs PR previews are well-hidden within GitHub's "Checks" interface.

![All checks have passed -- no indication there's a PR preview inside](/assets/github-all-checks-have-passed.png)

To improve findability of PR previews for users who are less familiar with this
behavior, I recommend using [ReadTheDocs' official action for making preview links more
findable](https://github.com/readthedocs/actions/tree/v1/preview).

![PR preview link is automatically added to PR description](/assets/github-rtd-pr-preview-in-description.png)


## :thinking: Why? {#sec-why}

GitHub Actions has restrictions on pull requests from forks for security reasons. Anyone
Expand Down

0 comments on commit 2d90ca9

Please sign in to comment.