[#2170] Add Blurbs for Repos #2191

georgetayqy · 2024-04-15T05:56:47Z

Part of #2170

Proposed commit message

Currently, there are no ways for student developers to append messages
for each of the repositories they would like to showcase using
RepoSense.

Let's move to implement a blurbs feature to allow individual student
developers to showcase their contributions to their project.

Other information

This feature requires Java 11 CI/CD to be implemented.

[#2177] Migrate to Java 11 Syntax and Features #2183

Co-Authored-By: Ryan Poon <[email protected]>

…implement-blurbs-feature

…kxd/RepoSense into implement-blurbs-feature

sopa301

LGTM! I like the formatting of the JSON files to make it easier to read. Is it possible to add a negative test case for the BlurbMap builder?

georgetayqy · 2024-05-03T11:44:04Z

@sopa301 Let me work on that and update you in the upcoming days!

georgetayqy · 2024-05-06T11:58:30Z

@sopa301 I have implemented new test cases for BlurbMap, please do let me know if there are any other aspects that are lacking in tests!

sopa301

LGTM!

ckcherry23

Thanks for working on this @asdfghjkxd and @sopa301!

Can you please also update the Customizing Reports page in the User Guide to explain how this feature can be used? Maybe it can be merged with the 'Add a title' section to be called 'Personalizing Reports', and the 2 personalization options can be mentioned underneath (titles and blurbs).

One more thing to note is that the current code is implemented such that blurbs can only be used for repos. In case we foresee adding blurbs for author groups (eg. CS3281 summary for a student) or just for repo-author pairs (eg. each CS2103T student mentions their contribution to the tP), then we can create a new issue for this. @damithc

build.gradle

frontend/cypress/tests/chartView/chartView_blurbs.cy.js

src/main/java/reposense/parser/MarkdownParser.java

ckcherry23

Can we restyle the blurb box to be more apparent? Right now, the grey color is too light.
Here are my suggestions:

Use #F6F8FA as the fill color
Use #E9EBEF as the border color
Use 1px for the border width
Use 4px for the border radius
Ensure the top padding is the same as the bottom padding when using a single line of plain text, which is the most common blurb content expected.

Current:

Suggested:

Also, it would be great if one of the @reposense/active-developers who did not contribute to this PR added their review too.

frontend/src/components/c-markdown-chunk.vue

ckcherry23

The frontend and docs LGTM. Once the backend comments are addressed, this should be good to go.

georgetayqy · 2024-05-12T11:54:37Z

@gok99 @ckcherry23 I have added the new changes as requested!

ckcherry23

LGTM! Thanks @sopa301 and @asdfghjkxd for your sprinting efforts today to wrap up this PR!

gok99

LGTM! Just one final request before we can merge this.

@asdfghjkxd @sopa301 This is a really cool feaure and I'm excited to discuss how we can expand on this:

As discussed earlier, I think having blurbs for author / none grouped views (in addition to repository) would be quite useful. Perhaps one of you could create an issue to discuss this.
Including blurbs in the one-stop config. I think since the config is meant to provide key features for people interested in quickly showcasing their work, adding the blurbs will add a lot of value. However, having two sources of blurbs will introduce complications. We can discuss this further in One-Stop Config File for Code Portfolio #2161.

src/systemtest/resources/ConfigSystemTest/blurbs.md

gok99

LGTM! Thanks for the speedy work today

github-actions · 2024-05-12T15:17:17Z

The following links are for previewing this pull request:

Dashboard Preview: https://dashboard-2191-pr-reposense-reposense.surge.sh
Docs Preview: https://docs-2191-pr-reposense-reposense.surge.sh

This reverts commit f4cad78.

damithc · 2024-05-12T15:35:28Z

Thanks @asdfghjkxd for this PR, and @ckcherry23 @gok99 @sopa301 for the reviews/guidance. 💯

ckcherry23 · 2024-05-12T15:36:53Z

Hi prof @damithc, I merged the PR without giving co-author credit to @sopa301 by mistake, but both @asdfghjkxd and @sopa301 were authors of this PR.

damithc · 2024-05-12T16:05:01Z

Hi prof @damithc, I merged the PR without giving co-author credit to @sopa301 by mistake, but both @asdfghjkxd and @sopa301 were authors of this PR.

Noted @ckcherry23 Thanks both @asdfghjkxd and @sopa301

damithc · 2024-05-14T11:32:41Z

@asdfghjkxd @sopa301 Which folder should contain the blurbs.md?
I tried both assets and configs folders with this file, but couldn't get it to show up in the dashboard.

sopa301 · 2024-05-14T11:38:58Z

Hi prof @damithc , the link should be the link to the branch instead of to the repo (because multiple branches from the same repo can be displayed). For example, https://github.com/AY2324S2-CS2103-F08-2/tp/tree/master instead of https://ay2324s2-cs2103-f08-2.github.io/tp/

If you want to configure the blurbs.md to point to the main/master branch if the repo link is specified, we can open an issue for it.

damithc · 2024-05-14T11:56:49Z

Hi prof @damithc , the link should be the link to the branch instead of to the repo (because multiple branches from the same repo can be displayed). For example, https://github.com/AY2324S2-CS2103-F08-2/tp/tree/master instead of https://ay2324s2-cs2103-f08-2.github.io/tp/

@sopa301 Ah, I see. I missed that part. It's working now after I added the branch. Thanks for the clarification.

If you want to configure the blurbs.md to point to the main/master branch if the repo link is specified, we can open an issue for it.

I guess no need. It's not too much extra work to specify the branch.

damithc · 2024-05-15T06:31:44Z

Feature in action https://nus-cs2103-ay2324s2.github.io/tp-dashboard

Implement Blurb Feature

f6a4c2c

georgetayqy requested a review from a team April 15, 2024 05:58

georgetayqy and others added 2 commits April 15, 2024 14:04

Implement Frontend Tests For Blurbs

b906f6e

Co-Authored-By: Ryan Poon <[email protected]>

Update frontend tests

f143dc5

georgetayqy mentioned this pull request Apr 15, 2024

[#2161] One-Stop Config File for Code Portfolio #2172

Closed

1 task

sopa301 added the s.ToReview label Apr 16, 2024

sopa301 added 10 commits April 30, 2024 21:43

Merge branch 'master' of https://github.com/reposense/RepoSense into …

f0d38cb

…implement-blurbs-feature

Merge branch 'implement-blurbs-feature' of https://github.com/asdfghj…

aaefdd5

…kxd/RepoSense into implement-blurbs-feature

Remove unintended changes

71c4c31

Undo unintended changes

ededbf9

Undo unintended changes

28d50b8

Fix style

970e2ec

Fix style

e323d51

Fix style

812a098

Undo title changes

b2967c2

Add removed spacing line in title

44fce64

sopa301 approved these changes May 2, 2024

View reviewed changes

sopa301 requested a review from a team May 2, 2024 09:07

Implement more test cases

21f2b69

georgetayqy requested a review from a team May 6, 2024 11:57

sopa301 approved these changes May 7, 2024

View reviewed changes

Merge branch 'master' into implement-blurbs-feature

405655e

ckcherry23 requested changes May 11, 2024

View reviewed changes

build.gradle Outdated Show resolved Hide resolved

frontend/cypress/tests/chartView/chartView_blurbs.cy.js Show resolved Hide resolved

src/main/java/reposense/parser/MarkdownParser.java Outdated Show resolved Hide resolved

ckcherry23 requested review from a team May 11, 2024 16:45

ckcherry23 requested changes May 11, 2024

View reviewed changes

ckcherry23 requested a review from a team May 11, 2024 18:50

ckcherry23 reviewed May 11, 2024

View reviewed changes

frontend/src/components/c-markdown-chunk.vue Outdated Show resolved Hide resolved

ckcherry23 and others added 2 commits May 12, 2024 17:19

Merge branch 'master' into implement-blurbs-feature

0e76fe4

Edit tests to use markdown syntax

a96eed5

ckcherry23 reviewed May 12, 2024

View reviewed changes

georgetayqy added 2 commits May 12, 2024 19:49

Refactor constants and remove dependencies

3f979da

Refactor BlurbMap

bcf7010

georgetayqy requested a review from a team May 12, 2024 11:54

ckcherry23 approved these changes May 12, 2024

View reviewed changes

ckcherry23 requested a review from a team May 12, 2024 12:03

ckcherry23 added s.FinalReview and removed s.ToReview labels May 12, 2024

gok99 requested changes May 12, 2024

View reviewed changes

src/systemtest/resources/ConfigSystemTest/blurbs.md Show resolved Hide resolved

Update blurbs

3791288

ckcherry23 requested a review from gok99 May 12, 2024 13:49

Add HTML text in blurbs

a37f1bf

gok99 approved these changes May 12, 2024

View reviewed changes

ckcherry23 added s.ToMerge and removed s.FinalReview labels May 12, 2024

ckcherry23 merged commit f4cad78 into reposense:master May 12, 2024
8 checks passed

ckcherry23 added a commit that referenced this pull request May 12, 2024

Revert "[#2170] Add Blurbs for Repos (#2191)"

51103e7

This reverts commit f4cad78.

This was referenced May 12, 2024

Add Blurbs for Repos, Authors and Charts #2170

Open

Rename test repos to correspond to their purpose #320

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#2170] Add Blurbs for Repos #2191

[#2170] Add Blurbs for Repos #2191

georgetayqy commented Apr 15, 2024 •

edited

Loading

sopa301 left a comment

georgetayqy commented May 3, 2024

georgetayqy commented May 6, 2024

sopa301 left a comment

ckcherry23 left a comment

ckcherry23 left a comment •

edited

Loading

ckcherry23 left a comment

georgetayqy commented May 12, 2024

ckcherry23 left a comment

gok99 left a comment •

edited

Loading

gok99 left a comment

github-actions bot commented May 12, 2024

damithc commented May 12, 2024

ckcherry23 commented May 12, 2024

damithc commented May 12, 2024

damithc commented May 14, 2024

sopa301 commented May 14, 2024 •

edited

Loading

damithc commented May 14, 2024

damithc commented May 15, 2024

[#2170] Add Blurbs for Repos #2191

[#2170] Add Blurbs for Repos #2191

Conversation

georgetayqy commented Apr 15, 2024 • edited Loading

Proposed commit message

Other information

sopa301 left a comment

Choose a reason for hiding this comment

georgetayqy commented May 3, 2024

georgetayqy commented May 6, 2024

sopa301 left a comment

Choose a reason for hiding this comment

ckcherry23 left a comment

Choose a reason for hiding this comment

ckcherry23 left a comment • edited Loading

Choose a reason for hiding this comment

ckcherry23 left a comment

Choose a reason for hiding this comment

georgetayqy commented May 12, 2024

ckcherry23 left a comment

Choose a reason for hiding this comment

gok99 left a comment • edited Loading

Choose a reason for hiding this comment

gok99 left a comment

Choose a reason for hiding this comment

github-actions bot commented May 12, 2024

damithc commented May 12, 2024

ckcherry23 commented May 12, 2024

damithc commented May 12, 2024

damithc commented May 14, 2024

sopa301 commented May 14, 2024 • edited Loading

damithc commented May 14, 2024

damithc commented May 15, 2024

georgetayqy commented Apr 15, 2024 •

edited

Loading

ckcherry23 left a comment •

edited

Loading

gok99 left a comment •

edited

Loading

sopa301 commented May 14, 2024 •

edited

Loading