Create specific instructions to enable PR preview for CS2103T tP users

[tlylt]

Please confirm that you have searched existing issues in the repo

Yes, I have searched the existing issues

Any related issues?

No response

What is the area that this feature belongs to?

Documentation

Is your feature request related to a problem? Please describe.

See https://github.com/nus-cs2103-AY2324S1/forum/issues/228#issuecomment-1741890709

Describe the solution you'd like

• Create a tailored guide with all the configurations/steps to take etc relevant to CS2103T tP users
• Test and create examples to illustrate each option
• Propose the documentation to https://se-education.org/guides/tutorials/markbind-forked-sites.html

Describe alternatives you've considered

No response

Additional context

No response

[yucheng11122017]

Hi @tlylt, can I check what part of the instructions need to be specific to CS2103? My impression is that the instructions to preview a PR in the markbind documentation is already quite comprehensive and nothing seems to be very specific to CS2103.

[tlylt]

Hi @tlylt, can I check what part of the instructions need to be specific to CS2103?

My impression is that the instructions to preview a PR in the markbind documentation is already quite comprehensive and nothing seems to be very specific to CS2103.

See the instructions I provided for how to setup with Netlify linked in the issue. I think just a more detailed step by step guide, including the details of the configuration values (e.g. my screenshot in that answer) would be helpful. As for tailoring to cs2103 students, I meant to say that the steps including all values that need to be filled in (value for base folder, build command etc), should all be clearly provided for a student who will use the ab3-markbind template. So they can simply follow the steps exactly. If it's actually the same as our dev guide, then take content from our dev guide.

[itsyme]

@tlylt what do you think about using AB3 as an example for the "instructions to review a PR" instead of explicitly stating that it is for CS2103? I feel that this subtler approach may be better to prevent confusion for non-NUS users in the future while still creating a way for CS2103 students to get more specific instructions.

[tlylt]

@tlylt what do you think about using AB3 as an example for the "instructions to review a PR" instead of explicitly stating that it is for CS2103? I feel that this subtler approach may be better to prevent confusion for non-NUS users in the future while still creating a way for CS2103 students to get more specific instructions.

This issue is primarily to create a custom instruction that will live in the ab3 related docs, not within markbind docs. In our docs yes we can adapt the content to make it generic.

[damithc]

Something related: Last time I checked (a few years ago), Netlify switched to this ugly practice of letting a free account exceed the free limit (rather than stop usage when the free limit is reaches), and blocking further use until the charges incurred is paid. If they are still doing the same, I'm not very keen to point CS2103/T students in the direction of Netlify, as the last stages of tP is likely to drive their Netlify account over the free limit (which is not that high anyway, and appears to be an absolute limit rather than a monthly limit).

[tlylt]

We can document the steps for surge.sh (if it's still available) as well. In addition, exploration can be done to add more PR preview mechanisms (in a separate issue/PR) e.g Vercel might work in similar fashion to Netlify.