Lower bar for contributions: add generated preview links to website PRs

[abrennan89]

Feature request

The bar seems very high for simple docs contributions: https://github.com/tektoncd/website/blob/main/DEVELOPMENT.md

I am pretty sure I have all of these tools installed, but to make sure I would need to go and find verification steps for each, since these aren't listed. I'd also need to go to each individual site to get install instructions if I didn't have any of the tools, rather than just a Getting Started type page that provides steps, or maybe a setup script.

There are also no minimum versions listed, so it's not clear if I would need to update things like Hugo where I may have an older version.

Rather than needing to do all this, it would be nice if I could just open a PR that generates a link to a netlify preview automatically.

Use case

As a new contributor to Tekton, I would like to easily be able to open a docs preview, without having to spend a lot of time setting it up locally.

Examples

• Knative docs: Add note about HTTPS knative/docs#4539 (comment)
• OpenShift docs: fixes footer overlap on welcome page openshift/openshift-docs#39410 (comment)

[AlanGreene]

Thanks for raising this issue @abrennan89, I agree that we could make the instructions clearer and the process more straightforward to help folks get up and running quickly. Having a handy reference of any prereqs (including versions) in one place would be a start.

We do have Netlify preview links on PRs already, see for example this PR: #298

Clicking the 'Details' link brings you to the Netlify preview deployment, for that PR it's https://deploy-preview-298--tekton.netlify.app/

We used to have instructions for running locally using netlify dev but I'm not sure why that was removed, maybe we could revisit that.

[afrittoli]

Thanks for raising this issue @abrennan89, I agree that we could make the instructions clearer and the process more straightforward to help folks get up and running quickly. Having a handy reference of any prereqs (including versions) in one place would be a start.

We do have Netlify preview links on PRs already, see for example this PR: #298

Clicking the 'Details' link brings you to the Netlify preview deployment, for that PR it's https://deploy-preview-298--tekton.netlify.app/

We used to have instructions for running locally using netlify dev but I'm not sure why that was removed, maybe we could revisit that.

I think the instructions are still there? Maybe we could push them up in the page and move the "docker compose" approach lower in the list.

[tekton-robot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

[tekton-robot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

[geriom]

We have a doc that covers how to run the site locally either installing the necessary dependencies or using docker compose. https://tekton.dev/docs/contribute/run-locally/

Maybe we can simplify the contributions landing page to make it more succinct and add clear instructions on how to preview your PR.

[tekton-robot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

[tekton-robot]

@tekton-robot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.