MarkBind Template for Student Portfolio #2398

jingting1412 · 2024-02-03T08:08:41Z

What is the purpose of this pull request?

Overview of changes:
Added a template portfolio website for users based on the existing default template generated when running markbind init ---template and existing portfolio themes available on jekyll.

#2385

Anything you'd like to highlight/discuss:

Testing instructions:
run markbind init --template portfolio and see if contents are loaded

Proposed commit message: (wrap lines at 72 characters)
Add portfolio template for init command

Checklist: ☑️

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

codecov · 2024-02-03T08:11:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.11%. Comparing base (8ad1b0c) to head (e3438a9).

❗ Current head e3438a9 differs from pull request most recent head f3ded34. Consider uploading reports for the commit f3ded34 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2398      +/-   ##
==========================================
+ Coverage   51.02%   51.11%   +0.08%     
==========================================
  Files         124      124              
  Lines        5372     5355      -17     
  Branches     1159     1152       -7     
==========================================
- Hits         2741     2737       -4     
+ Misses       2341     2328      -13     
  Partials      290      290

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

yucheng11122017

Thanks for the work @jingting1412! The portfolio page looks nice.

packages/core/template/portfolio/_markbind/variables.md

packages/core/template/portfolio/index.md

docs/userGuide/templates.md

yucheng11122017 · 2024-02-08T08:12:41Z

Hi @jingting1412, actually if you are looking for inspiration, you can check out these portfolios that the team thinks is nice!

Jovyn Tan @jovyntls LMAO
Charisma @ckcherry23

yucheng11122017

Hi @jingting1412 thanks for the changes!
One comment on moving the icons and thumbnails

packages/core/template/portfolio/contents/experience.md

yucheng11122017

LGTM! Thanks for the work @jingting1412

Lack of tests

yucheng11122017 · 2024-02-17T06:55:30Z

Sorry @jingting1412, one more thing!
Could you add functional test for the template?

jingting1412 · 2024-02-19T04:48:15Z

Sorry @jingting1412, one more thing! Could you add functional test for the template?

Yep added! Sorry for not noticing earlier

yucheng11122017

LGTM! Will wait for more comments before merging :)
@kaixin-hc @EltonGohJH @itsyme

lhw-1 · 2024-02-21T04:25:41Z

Hi, thanks for the PR @jingting1412! I've taken a look at the template, and I just have a few broad comments / suggestions that has to do with the UI / UX rather than the implementation itself:

For a student portfolio, I would imagine that a sleek look would be preferred instead of too much clutter (though we could assume that this would be their first ever portfolio that they are setting up).
- I think we can reduce the clutter in the top navbar to only contain the GitHub and the LinkedIn logo - the search function is unlikely to be used, and the topics on the sidebar should be sufficient for navigation, since we aren't expecting a particularly lengthy site.
- Breadcrumbs may not be needed for the same reason - the site is unlikely to be too lengthy.
I think we can include "Skills" and "Experience" as topics on the main page rather than as a separate page?
- "Skills" can be the set of tech that the student has used previously, so I'm thinking of maybe having three Panels titled "Languages", "Frameworks & Tools", and "Others" respectively. And within those panels, maybe we can include examples for these. The two portfolio links that @yucheng11122017 posted has some possible examples.
- It would be nice to present "Experience" as a simple timeline similar to how LinkedIn presents it, so Boxes might be suitable here? It might be also useful to make use of the vertical line created by a Blockquote here.
The main container on the main page can be used to display: Name, short description, and profile image. Basically, embed the "Hello there! ..." section's current content into the black container instead of repeating the same-ish content twice.
We could add some styling for the individual projects pages as well, similar to the layouts used by the two aforementioned portfolio links!
The "Navigating this site" section will need to be updated - and maybe we can also include some information indicating that this portfolio is a simplified version (if we do decide to remove some navbar features, etc), and if the student wants access to more features, they can use other templates instead.

These are suggestions rather than directions, and feel free to counter these if you feel that they are not preferable 👍

new comments

jingting1412 · 2024-03-30T16:16:24Z

Thanks everyone for the review! I've updated the site and it looks like this now: https://portfolio-template-markbind.netlify.app/

kaixin-hc · 2024-04-03T02:54:09Z

packages/core/template/portfolio/contents/projects.md

+            {{ vue }}
+        </div>
+        <div class="card-body">
+            <a href="#" class="btn btn-primary">View on Github</a>


Suggest that this link should go to MarkBind github and the one below should go to MarkBind website

Hi thanks for the suggestion, I've added it and you can check it out here: https://portfolio-template-markbind.netlify.app/

Great! @jingting1412 the button next to this seems wrong tho? What is "post"

I was thinking that "Devpost" seems a bit inaccurate, since we're linking to documentation, but yeah "post" might be a little confusing too 😓. I'll change it back to Devpost

…o/expected/index.html Co-authored-by: Kevin Eyo <[email protected]>

yucheng11122017

LGTM except for the broken link

itsyme · 2024-04-04T07:19:03Z

packages/cli/test/functional/test_site_templates/test_portfolio/expected/index.md

+        </a>
+      </span>
+    </div>
+    <a class="btn btn-primary" href="./contents/assets/ug_template.docx" download="UG-template-resume" role="button">Resume</a>


Perhaps using Download Resume could be more indicative to the viewer that it is a button to download as my expected intention when clicking the button is to be brought to a page showing the resume. Another way to go about this could be to exporting the docx file to pdf to allow it to be opened in a new tab instead of forcing a download. Imo using the pdf would be my preference

Yep makes sense! I've changed it to the pdf file, you can check it again here: https://portfolio-template-markbind.netlify.app/

itsyme

LGTM! Thanks for the research and effort put into creating this template!

github-actions · 2024-04-08T13:44:01Z

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

jingting1412 and others added 7 commits January 29, 2024 12:41

Add default files for template

a707f53

Basic structure

e28ccbb

Add content for template

aa05707

Merge branch 'MarkBind:master' into portfolioTemplate

7f295f1

Fix typo

665f5dc

Update userguide

84f1f46

Add link to netlify

8a7442a

yucheng11122017 reviewed Feb 6, 2024

View reviewed changes

jingting1412 and others added 4 commits February 11, 2024 17:17

implement changes

2e49d48

Change variable

4272144

Merge branch 'master' into portfolioTemplate

b276680

Merge branch 'master' into portfolioTemplate

e181ca3

yucheng11122017 reviewed Feb 15, 2024

View reviewed changes

packages/core/template/portfolio/contents/experience.md Outdated Show resolved Hide resolved

jingting1412 and others added 3 commits February 16, 2024 12:53

Merge branch 'MarkBind:master' into portfolioTemplate

3023603

Shift skills section

b35ccbe

Fix variable mistake

be14ede

yucheng11122017 previously approved these changes Feb 17, 2024

View reviewed changes

yucheng11122017 self-requested a review February 17, 2024 06:54

jingting1412 and others added 2 commits February 19, 2024 12:37

Add functional test

f342c87

Merge branch 'MarkBind:master' into portfolioTemplate

d4b2683

yucheng11122017 previously approved these changes Feb 21, 2024

View reviewed changes

kaixin-hc requested a review from yucheng11122017 February 22, 2024 16:56

Merge branch 'MarkBind:master' into portfolioTemplate

141436a

jingting1412 added 4 commits March 30, 2024 23:51

Implement review suggestions

f9f8262

Update tests

7f013b6

Add email link

e3c41f8

Update tests

1dce15e

Merge branch 'MarkBind:master' into portfolioTemplate

7800aee

kaixin-hc reviewed Apr 3, 2024

View reviewed changes

jingting1412 and others added 7 commits April 3, 2024 13:54

Update packages/cli/test/functional/test_site_templates/test_portfoli…

83e88e5

…o/expected/index.html Co-authored-by: Kevin Eyo <[email protected]>

Update packages/cli/test/functional/test_site_templates/test_portfoli…

d2d5230

…o/expected/index.html Co-authored-by: Kevin Eyo <[email protected]>

Update packages/cli/test/functional/test_site_templates/test_portfoli…

299f4a4

…o/expected/index.html Co-authored-by: Kevin Eyo <[email protected]>

Add links to projects

49245a5

Change name for post

37dec16

Change look of experience

612cbd9

Update tests

62a8fad

yucheng11122017 approved these changes Apr 4, 2024

View reviewed changes

itsyme reviewed Apr 4, 2024

View reviewed changes

jingting1412 and others added 6 commits April 4, 2024 16:17

Implement review changes

4bf2a7a

Update tests

c83b6dd

Update post

6cfe7b9

Remove unused image

2aeb573

Fix broken link

b7dba93

Merge branch 'MarkBind:master' into portfolioTemplate

e3438a9

itsyme approved these changes Apr 4, 2024

View reviewed changes

yucheng11122017 force-pushed the master branch 2 times, most recently from cb84513 to 69ec838 Compare April 5, 2024 06:21

Fix merge conflicts

f3ded34

yucheng11122017 merged commit 147899a into MarkBind:master Apr 8, 2024
7 checks passed

yucheng11122017 added the r.Minor Version resolver: increment by 0.1.0 label Apr 8, 2024

kaixin-hc mentioned this pull request May 8, 2024

Add Netlify deploy buttons for templates #2552

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MarkBind Template for Student Portfolio #2398

MarkBind Template for Student Portfolio #2398

jingting1412 commented Feb 3, 2024 •

edited

Loading

codecov bot commented Feb 3, 2024 •

edited

Loading

yucheng11122017 left a comment

yucheng11122017 commented Feb 8, 2024 •

edited

Loading

yucheng11122017 left a comment

yucheng11122017 left a comment

yucheng11122017 commented Feb 17, 2024

jingting1412 commented Feb 19, 2024

yucheng11122017 left a comment

lhw-1 commented Feb 21, 2024

jingting1412 commented Mar 30, 2024

kaixin-hc Apr 3, 2024

jingting1412 Apr 3, 2024

kaixin-hc Apr 4, 2024

jingting1412 Apr 4, 2024

yucheng11122017 left a comment

itsyme Apr 4, 2024

jingting1412 Apr 4, 2024

itsyme left a comment

github-actions bot commented Apr 8, 2024

MarkBind Template for Student Portfolio #2398

MarkBind Template for Student Portfolio #2398

Conversation

jingting1412 commented Feb 3, 2024 • edited Loading

codecov bot commented Feb 3, 2024 • edited Loading

Codecov Report

yucheng11122017 left a comment

Choose a reason for hiding this comment

yucheng11122017 commented Feb 8, 2024 • edited Loading

yucheng11122017 left a comment

Choose a reason for hiding this comment

yucheng11122017 left a comment

Choose a reason for hiding this comment

yucheng11122017 commented Feb 17, 2024

jingting1412 commented Feb 19, 2024

yucheng11122017 left a comment

Choose a reason for hiding this comment

lhw-1 commented Feb 21, 2024

jingting1412 commented Mar 30, 2024

kaixin-hc Apr 3, 2024

Choose a reason for hiding this comment

jingting1412 Apr 3, 2024

Choose a reason for hiding this comment

kaixin-hc Apr 4, 2024

Choose a reason for hiding this comment

jingting1412 Apr 4, 2024

Choose a reason for hiding this comment

yucheng11122017 left a comment

Choose a reason for hiding this comment

itsyme Apr 4, 2024

Choose a reason for hiding this comment

jingting1412 Apr 4, 2024

Choose a reason for hiding this comment

itsyme left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 8, 2024

jingting1412 commented Feb 3, 2024 •

edited

Loading

codecov bot commented Feb 3, 2024 •

edited

Loading

yucheng11122017 commented Feb 8, 2024 •

edited

Loading