Deploy portfolio on netlify #2593

IanCheah · 2025-02-05T18:29:12Z

What is the purpose of this pull request?

Fixes #2418

Overview of changes:

Deployed portfolio site on netlify
Updated the templates.md page

Anything you'd like to highlight/discuss:
The preview of the portfolio site can be seen here

Testing instructions:

run the command markbind s
navigate to the templates page
i. Click on the USER GUIDE tab located at the top of the home page
ii. Click on the Templates tab located at the side, under Working with Sites

Proposed commit message: (wrap lines at 72 characters)
Deploy portfolio on Netlify

Checklist: ☑️

Updated the documentation for feature additions and enhancements
Added tests for bug fixes or features
Linked all related issues
No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

Major (when you make incompatible API changes)
Minor (when you add functionality in a backward compatible manner)
Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

what was the old feature that was made obsolete

any replacement feature (if any), and

how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

lhw-1 · 2025-02-07T10:02:25Z

The porfolio site is publicly accessible using the following url https://markbind-template-portfolio.netlify.app/.

Quick link here

lhw-1 · 2025-02-07T10:08:49Z

@IanCheah The deployment itself looks rather different from this one here mentioned in the PR #2398 for the template; there are of course bound to be some changes, but the icons etc. seem to be displayed incorrectly?

gerteck · 2025-02-07T18:27:47Z

Reference Documentation Site in Question: https://markbind.org/userGuide/templates.html

Something doesn't seem right... The buttons represent deploy to Netlify links, not sample sites of the templates.

These are actually quick deploy links provided by MarkBind, that create a repository for you and deploy in a single click.

In fact, this highlights that the project template netlify-deploy button is also wrongly labelled.
It was probably overlooked in #2400 because a great deal of effort was spent in the design of the site, such that the documentation was wrongly labelled.

Also the site https://markbind-template-portfolio.netlify.app/ looks broken on my end too. (Needs to be investigated).

I have a few suggestions:

Add maybe a separate column as 'sample site' or 'example site' for each template.
Consider adding this for default and minimal as well.
Fix the project template quick deploy link, because it's not a quick deploy link. Instead, maybe put it under sample site or related, as it's quite helpful.
Fix and simplify the portfolio template, right now it seems a bit convoluted (and also seems broken). As discussed in our last meeting, it could be beneficial to simplify and even target certain audiences (i. e. cs2103t / cs2113 students) since they have a touchpoint with markbind and are probably the most likely to be new users. This could mean adding a sample tP project, and maybe an orbital section as well.

These suggestions could be made out into separate issues as well to be appropriate handled and tracked.

Cheers 👍

Tim-Siu · 2025-02-10T04:24:42Z

Reference Documentation Site in Question: https://markbind.org/userGuide/templates.html

Something doesn't seem right... The buttons represent deploy to Netlify links, not sample sites of the templates.

These are actually quick deploy links provided by MarkBind, that create a repository for you and deploy in a single click.

https://github.com/MarkBind/init-typical-netlify

https://github.com/MarkBind/init-minimal-netlify

In fact, this highlights that the project template netlify-deploy button is also wrongly labelled. It was probably overlooked in #2400 because a great deal of effort was spent in the design of the site, such that the documentation was wrongly labelled.

Also the site https://markbind-template-portfolio.netlify.app/ looks broken on my end too. (Needs to be investigated).

I have a few suggestions:

Add maybe a separate column as 'sample site' or 'example site' for each template.

Consider adding this for default and minimal as well.

Fix the project template quick deploy link, because it's not a quick deploy link. Instead, maybe put it under sample site or related, as it's quite helpful.

Fix and simplify the portfolio template, right now it seems a bit convoluted (and also seems broken). As discussed in our last meeting, it could be beneficial to simplify and even target certain audiences (i. e. cs2103t / cs2113 students) since they have a touchpoint with markbind and are probably the most likely to be new users. This could mean adding a sample tP project, and maybe an orbital section as well.

These suggestions could be made out into separate issues as well to be appropriate handled and tracked.

Cheers 👍

Great catch on the misleading "Deploy to Netifly" label. I also agree that we should add a seperate column about sample deployment.👍

codecov · 2025-02-16T03:28:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.86%. Comparing base (92d2373) to head (a667c5f).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2593   +/-   ##
=======================================
  Coverage   51.86%   51.86%           
=======================================
  Files         127      127           
  Lines        5474     5474           
  Branches     1201     1201           
=======================================
  Hits         2839     2839           
  Misses       2340     2340           
  Partials      295      295

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lhw-1 · 2025-02-20T06:11:41Z

Hi, what's the progress on this PR?

IanCheah · 2025-02-20T06:21:04Z

Hi @lhw-1, as I am working on issue #2594 I have not made the changes to the PR. will incorporate the changes discussed by the end of this week

…IanCheah/markbind into branch-deploy-student-portfolio

gerteck

This looks awesome!

The updated page can be viewed here:
https://deploy-preview-2593--markbind-master.netlify.app/userguide/templates#templates

Old page for reference.

LGTM

lhw-1 · 2025-03-10T13:30:30Z

Personally, the PR is LGTM - with just one nit. Instead of using the icon for the sample sites, it might be better to just use text-based buttons to be consistent with the rest of the user guide.

Are there places where we are using icon buttons for similar purpose @IanCheah?

IanCheah · 2025-03-10T15:14:01Z

I agree with that, I wanted to use a button because the deploy on netlify also uses a button. I overlooked the fact that it uses a text-based one.

Personally, the PR is LGTM - with just one nit. Instead of using the icon for the sample sites, it might be better to just use text-based buttons to be consistent with the rest of the user guide.

Are there places where we are using icon buttons for similar purpose @IanCheah?

lhw-1 · 2025-03-12T05:22:54Z

I agree with that, I wanted to use a button because the deploy on netlify also uses a button. I overlooked the fact that it uses a text-based one.

@IanCheah Will you be updating the PR with this soon? If so, please do update it - if not, we may merge this PR in first.

IanCheah · 2025-03-12T09:45:17Z

I agree with that, I wanted to use a button because the deploy on netlify also uses a button. I overlooked the fact that it uses a text-based one.

@IanCheah Will you be updating the PR with this soon? If so, please do update it - if not, we may merge this PR in first.

Yes, I am done with it. What do you think about this?

lhw-1

LGTM! Thanks @IanCheah for the PR :)

github-actions · 2025-03-12T15:26:04Z

@lhw-1 Each PR must have a SEMVER impact label, please remember to label the PR properly.

github-actions · 2025-03-12T15:26:07Z

Welcome, @IanCheah! 🎉 Thank you for your contribution to the MarkBind project!

@lhw-1, please remember to add @IanCheah as an official contributor to our repository.

See the full list of contributors here. ✨

lhw-1 · 2025-03-14T15:03:10Z

@all-contributors please add @IanCheah for doc

allcontributors · 2025-03-14T15:03:37Z

@lhw-1

I've put up a pull request to add @IanCheah! 🎉

Deploy portfolio on netlify

edc8ef8

Merge branch 'master' into branch-deploy-student-portfolio

a667c5f

lhw-1 added 2 commits February 16, 2025 11:42

Merge branch 'master' into branch-deploy-student-portfolio

68e04e5

Merge branch 'master' into branch-deploy-student-portfolio

1a823a3

IanCheah mentioned this pull request Feb 23, 2025

Quick deploy link for "Project" not working as intended #2611

Open

IanCheah and others added 3 commits February 24, 2025 01:22

Add Sample sites

1e0fddf

Merge branch 'MarkBind:master' into branch-deploy-student-portfolio

f66c0e4

Merge branch 'branch-deploy-student-portfolio' of https://github.com/…

5e7c93b

…IanCheah/markbind into branch-deploy-student-portfolio

IanCheah marked this pull request as draft February 23, 2025 17:33

IanCheah added 2 commits February 24, 2025 01:34

Add preview icon

3c5da9a

Update url of the repositories for deployment

3770ab8

IanCheah marked this pull request as ready for review March 9, 2025 12:06

gerteck approved these changes Mar 9, 2025

View reviewed changes

gerteck requested a review from lhw-1 March 9, 2025 13:13

lhw-1 added the r.Minor Version resolver: increment by 0.1.0 label Mar 10, 2025

Merge branch 'master' into branch-deploy-student-portfolio

8e7b03c

Merge branch 'master' into branch-deploy-student-portfolio

eda443e

Update preview button

8a9dfe6

lhw-1 approved these changes Mar 12, 2025

View reviewed changes

lhw-1 merged commit acf4f7a into MarkBind:master Mar 12, 2025
8 checks passed

lhw-1 added this to the v5.6.0 milestone Mar 13, 2025

allcontributors bot mentioned this pull request Mar 14, 2025

add IanCheah as a contributor for doc #2645

Merged

Incogdino mentioned this pull request Apr 3, 2025

MarkBind Template for Student Portfolio #2385

Closed

lhw-1 mentioned this pull request Apr 4, 2025

Add files for deployment of portfolio MarkBind/init-portfolio-netlify#1

Merged

14 tasks

Deploy portfolio on netlify #2593

Deploy portfolio on netlify #2593

Uh oh!

Conversation

IanCheah commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lhw-1 commented Feb 7, 2025

Uh oh!

lhw-1 commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gerteck commented Feb 7, 2025

Uh oh!

Tim-Siu commented Feb 10, 2025

Uh oh!

codecov bot commented Feb 16, 2025

Codecov Report

Uh oh!

lhw-1 commented Feb 20, 2025

Uh oh!

IanCheah commented Feb 20, 2025

Uh oh!

gerteck left a comment

Choose a reason for hiding this comment

Uh oh!

lhw-1 commented Mar 10, 2025

Uh oh!

IanCheah commented Mar 10, 2025

Uh oh!

lhw-1 commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanCheah commented Mar 12, 2025

Uh oh!

lhw-1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 12, 2025

Uh oh!

github-actions bot commented Mar 12, 2025

Uh oh!

lhw-1 commented Mar 14, 2025

Uh oh!

allcontributors bot commented Mar 14, 2025

Uh oh!

Uh oh!

IanCheah commented Feb 5, 2025 •

edited

Loading

lhw-1 commented Feb 7, 2025 •

edited

Loading

lhw-1 commented Mar 12, 2025 •

edited

Loading