Feature Request
There was interest in having PRs for documentation updates to have CI add a comment with link to preview the changes visually.
This has been discussed during the Github Wiki to MkDocs (via Github Pages) migration work. A free service can provide this functionality, and be integrated via Github Actions for CI.
Context
I have offered to contribute this, however as this project now exists as an organization, it requires a bit more effort on behalf of organization members to make arrangements for being granted an open-source organization team plan (free if approved) on either of the two popular services:
- Netlify is more open about their support for this here, with requirements and actions required to get approval.
- Vercel is my original choice, they briefly mention some form of support for open-source projects beyond the personal hobby account near the bottom of their pricing page.
I've done most of my research into supporting Vercel, but from what I can tell it should be a similar process with Netlify:
- Connecting the organization/team and project to the service.
- A configuration file to disable default default branch and PR behaviour (lacks context of when it should be triggered)
- A third-party Github Action that only triggers under the PR event for PRs that actually touch the docs.
Is your Feature Request related to a Problem?
It would assist with PR reviews related to documentation contributions.
Describe the Solution you'd like
Leveraging the free tier support of Vercel or Netlify services with the preview deploy links.
The organization has already expressed interest in keeping deployment of docs tied to Github Pages. That does have some slight disadvantages compared to these services feature wise (eg rewrites, redirects, 404 handling, cache control, etc), but with the above plan of action the service can specifically only deploy previews AFAIK.
Are you going to implement it?
Yes, because I know the probability of someone else doing it is low and I can learn from it.
What are you going to contribute??
Everything required to enable the feature.
Additional context
I cannot proceed further with either service until the organization (EDIT: I've been made a member, I'll take care of it) decides on a service to use and has taken action to be granted approval for the open-source free team plan.
Alternatives you've considered
I'm not sure of what other alternatives we have, other than more DIY, but this would raise the difficulty and add more maintenance burden due to low bus factor than using one of these popular services would.
Who will that Feature be useful to?
Maintainers and/or reviewers of pull requests for documentation.
What have you done already?
Investigated required tasks and effort to contribute the feature.
Feature Request
There was interest in having PRs for documentation updates to have CI add a comment with link to preview the changes visually.
This has been discussed during the Github Wiki to MkDocs (via Github Pages) migration work. A free service can provide this functionality, and be integrated via Github Actions for CI.
Context
I have offered to contribute this, however as this project now exists as an organization, it requires a bit more effort on behalf of organization members to make arrangements for being granted an open-source organization team plan (free if approved) on either of the two popular services:
I've done most of my research into supporting Vercel, but from what I can tell it should be a similar process with Netlify:
Is your Feature Request related to a Problem?
It would assist with PR reviews related to documentation contributions.
Describe the Solution you'd like
Leveraging the free tier support of Vercel or Netlify services with the preview deploy links.
The organization has already expressed interest in keeping deployment of docs tied to Github Pages. That does have some slight disadvantages compared to these services feature wise (eg rewrites, redirects, 404 handling, cache control, etc), but with the above plan of action the service can specifically only deploy previews AFAIK.
Are you going to implement it?
Yes, because I know the probability of someone else doing it is low and I can learn from it.
What are you going to contribute??
Everything required to enable the feature.
Additional context
I cannot proceed further with either service until the organization(EDIT: I've been made a member, I'll take care of it) decides on a service to use and has taken action to be granted approval for the open-source free team plan.Alternatives you've considered
I'm not sure of what other alternatives we have, other than more DIY, but this would raise the difficulty and add more maintenance burden due to low bus factor than using one of these popular services would.
Who will that Feature be useful to?
Maintainers and/or reviewers of pull requests for documentation.
What have you done already?
Investigated required tasks and effort to contribute the feature.