inbo / tutorials

A collection of technical tutorials for INBO (and anyone who's interested)
https://inbo.github.io/tutorials/
Creative Commons Attribution 4.0 International
22 stars 9 forks source link

PR instructions unclear #291

Closed LienReyserhove closed 2 years ago

LienReyserhove commented 2 years ago

Upon making the PR for #290, the following instructions are quite complex for me.

So perhaps some justification and simplification might be interesting here? It depends on who's making a PR of course.


### Instructions

1) On the PR page, you can find a "details" link under "checks - On PR, build the site and ...". Go there, click on the top link in the left sidebar ("Summary"), and download the generated artifact at the bottom of the page.
2) Decompress it and make sure the target directory is called 'tutorials' (you may need to rename it)
3) From the parent directory (just above the `tutorials` folder you created/renamed), run `python -m http.server 8887`, _or_ launch the Google Chrome [Web Server app](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb) and point it at the parent directory.
4) Point your browser to http://localhost:8887/tutorials.
5) Review the updated website and accept/refuse/comment the PR

**Note: for step 3, you can use any other simple HTTP server to serve the current directory if you don't have a Python 3 environment or Google Chrome available.**
florisvdh commented 2 years ago

Thanks for pinpointing confusing things. Considering the 'why': the 'instructions' title is a subtitle of:

Previewing the pull request

Thanks to GitHub Actions, an artifact (=zip file) of the rendered website is automatically created for each pull request.

If the title 'Instructions' were modified to 'Instructions to render the updated website triggered by the pull request ', would this clarify? In essence, it is a way to preview how your contribution will render after merging, so both the PR author(s) and reviewers can use that for reviewing or further checking.

Step 5, it seems, is only formulated for reviewers, not contributors, so that is better extended. Also, the above cited paragraph could be extended by 'This is a way to preview how your contribution will render ...' as just explained.

You're most welcome to improve it based on these explanations and your own insights; the file to update is https://github.com/inbo/tutorials/blob/master/.github/pull_request_template.md. Also it seems that the file REVIEWING.md, where that information originally resided, is still linked in https://github.com/inbo/tutorials#reviewing-the-website-in-a-pull-request-before-merging, currently a dead link so that's also something to update. See also https://github.com/inbo/tutorials/pull/278, where this move happened, and where you also find some additional explanation about the workflow, also regarding step 3.

florisvdh commented 2 years ago

Also it seems that the file REVIEWING.md, where that information originally resided, is still linked in https://github.com/inbo/tutorials#reviewing-the-website-in-a-pull-request-before-merging, currently a dead link so that's also something to update.

See also issue #292. Solved by PR #296.