Skip to content

Commit

Permalink
Merge pull request #513 from RichDom2185/week13/style-ppp-pr-badge
Browse files Browse the repository at this point in the history
Add and style PR badge for PPP
  • Loading branch information
RichDom2185 authored Nov 6, 2022
2 parents 535d956 + 758a108 commit eff9826
Show file tree
Hide file tree
Showing 10 changed files with 301 additions and 182 deletions.
4 changes: 4 additions & 0 deletions docs/_includes/icons/git-merge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/_includes/ppp-badges.liquid
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{% comment %}
Copyright 2022 Richard Dominick
{% endcomment %}
{% capture newline %}
{% endcapture %}
{%- assign nodes = include.html
| strip
| split: '[['
-%}
{{ nodes.first }}
{%- for node in nodes offset:1 -%}
{% assign data = node | split: ']]' %}{% assign tag = data | first | strip | split: '#' %}{% assign type = tag | first | strip %}{% assign number = tag | last | strip %}
{%- if type == 'PR' -%}
<span class="pr-badge">
{% include icons/git-merge.svg class="icon" %}
<a href="https://github.com/{{ site.repository }}/pull/{{ number }}">PR#{{ number }}</a>
<span class="tooltip"><strong>Pull Request</strong> #{{ number }}<br><small>View on GitHub</small></span>
</span>
{%- for tail in data offset:1 -%}
{{ tail }}
{%- endfor -%}
{%-else -%}
[[{{ node }}
{%- endif -%}
{%- endfor -%}
2 changes: 1 addition & 1 deletion docs/_layouts/ppp.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
layout: page
---
{{ content }}
{% include ppp-badges.liquid html=content %}
100 changes: 100 additions & 0 deletions docs/_sass/ppp.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
.pr-badge {
$color: #8250df;
$border-color: #d0d7de;

vertical-align: text-bottom;

display: inline-flex;
column-gap: 4px;
align-items: center;

background-color: #f8f8f8;
border-radius: 3px;
border: 1px solid $border-color;

margin-inline: 2px;
padding: 2px 4px;

> a {
display: inline-block;
color: inherit !important;
line-height: 100%;
font-weight: bold;
font-size: 0.75em;
text-decoration: none;
}

&:hover > a {
color: $link-base-color !important;
}

.icon {
$size: 14px;
fill: $color;
vertical-align: text-top;
display: inline-block;
height: $size;
width: $size;
}

position: relative;

> .tooltip {
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;

border: 1px solid $border-color;

$width: 180px;
width: $width;
margin-left: calc(-#{$width} / 2);
box-sizing: border-box;
padding: 6px 10px;

background-color: white;
border-radius: 6px;
color: gray;
font-size: small;

position: absolute;
bottom: 150%;
left: 50%;
text-align: center;

strong {
color: black;
}

// Popup arrow
&::after {
$arrow-width: 5px;
content: "";
position: absolute;
top: 100%;
left: 50%;
margin-left: -$arrow-width;
border-width: $arrow-width;
border-style: solid;
border-color: $border-color transparent transparent transparent;
}

:last-child {
font-size: smaller;
}

visibility: hidden;
opacity: 0;
transition: opacity ease-in-out 150ms;

@media screen and (prefers-reduced-motion: reduce) {
transition: none;
}
}

&:hover > .tooltip {
opacity: 1;
visibility: visible;
}
}
1 change: 1 addition & 0 deletions docs/assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"foodrem",
"admonitions",
"toc",
"ppp",
"pdf";

.icon {
Expand Down
10 changes: 5 additions & 5 deletions docs/team/bryanljx.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,26 @@ Given below are my contributions to the project.

**Refactoring**:

* **Refactored Feature**: Refactored `tag` model ([PR#140](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/140))
* **Refactored Feature**: Refactored `tag` model ([[PR#140]])
* What it does: encapsulates the idea of `tag` so that users can create and add `tag` to `item`.
* Justification: This feature allows `item` to be classified into different categories. The refactoring allows for creating of any tags as well as updating of the restrictions we would like to place on names for `tag`.
* Highlights: This refactoring allows users to create any `tag` they want. Through the use of regex, it also updates the restrictions we would like to place on names for `tag`, such as character limit or disallowed characters.

* **Refactored Feature**: Added storage for `tag` model ([PR#223](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/223))
* **Refactored Feature**: Added storage for `tag` model ([[PR#223]])
* What it does: Adds storage functionality for the refactored `tag` model.
* Justification: This feature is needed as we needed to store a separate list for `tag` besides the `item` list.

**New feature**:

* **New Feature**: Added `renametag` command ([PR#179](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/179))
* **New Feature**: Added `renametag` command ([[PR#179]])
* What it does: Allows for renaming of existing `tag`.
* Justification: Users might make errors in creating `tag` so we want to allow them to rename `tag`.

* **New Feature**: Added `deletetag` command ([PR#199](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/199))
* **New Feature**: Added `deletetag` command ([[PR#199]])
* What it does: Allows for deletion of existing `tag`.
* Justification: To allow users to delete `tag` no longer used.

* **New Feature**: Added `filtertag` command ([PR#302](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/302), [PR#353](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/353))
* **New Feature**: Added `filtertag` command ([[PR#302]], [[PR#353]])
* What it does: Allows for filtering for `item` by `tag`.
* Justification: This feature is the core functionality added by `tag`. We can classify `item` by `tag` so naturally we would like to filter by `tag`.
* Credits: Thanks to `eugenetanwl3881` for catching a bug with the Ui related to `filtertag`.
Expand Down
40 changes: 19 additions & 21 deletions docs/team/eugenetanwl3881.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,48 +16,46 @@ Given below are my contributions to the project.

* What it does: allows the user to tag a valid item with a valid tag (PR [\#171](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/171), [\#172](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/172))
* Justification: This feature improves the product significantly since a user will be able to tag items with a specific tag for classification purposes. This tag will be unique and can be referenced by any item if the item contains this tag
* Highlights: This enhancement will allow for better classification and searching for items in other commands. For instance
* Highlights: This enhancement will allow for better classification and searching for items in other commands. For instance

* **New Feature**: Added the ability untag an item (PR [\#172](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/172))
* What it does: Similar to tag feature, just that items can be untagged if user does not want to use that tag to classify an item anymore.
* What it does: Similar to tag feature, just that items can be untagged if user does not want to use that tag to classify an item anymore.

* **New Feature**: Added the ability list all tags (PR [\#200](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/200))

* What it does: User can call the `listtag` command to see all the tags that is available
* Justification: User may not remember what were the tags he has created or deleted, hence will need a way to check
* Highlights: This feature will be useful when trying to use other tag commands since user can see all the available tags
* What it does: User can call the `listtag` command to see all the tags that is available
* Justification: User may not remember what were the tags he has created or deleted, hence will need a way to check
* Highlights: This feature will be useful when trying to use other tag commands since user can see all the available tags

* **Refactored feature**:
* Refactored the `clear` command in AB3 to the `reset` command in FoodRem. This clears all items and tags stored (PR [\#160](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/160))


* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2223s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-09-16&tabOpen=true&tabType=authorship&tabAuthor=Eugenetanwl3881&tabRepo=AY2223S1-CS2103T-W16-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=functional-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)

* **Project management**:
* Refactoring done to project packages (PR [\#149](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/149))
* Team tasks: Creation of issues, completing some weekly team tasks, updating AboutUs (PR [\#241](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/241), [PR#22](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/22))
* Team tasks: Creation of issues, completing some weekly team tasks, updating AboutUs (PR [\#241](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/241), [[PR#22]])

* **Testing**:
* Wrote some tests for tag features (PRs [\#235](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/235))

* **Documentation**:

* User Guide:
* Added documentation for the commands `list`, `find`, `exit` ([PR#77](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/77))
* Add FAQ into UG ([PR#178](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/178))
* Add Command Summary Table ([PR#152](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/152))
* Updating sections and fixing bugs for UG ([PR#261](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/261), [PR#292](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/292), [PR#306](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/306), [PR#420](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/420) )
* Added documentation for the commands `list`, `find`, `exit` ([[PR#77]])
* Add FAQ into UG ([[PR#178]])
* Add Command Summary Table ([[PR#152]])
* Updating sections and fixing bugs for UG ([[PR#261]], [[PR#292]], [[PR#306]], [[PR#420]] )

* Developer Guide:
* Added User Stories and Use Cases in DG ([PR#79](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/79), [PR#142](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/142))
* Added NFRs in DG ([PR#57](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/57))
* Added implementation details of the `newtag` and `tag` feature. ([PR#230](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/230), [PR#464](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/464))
* DG User Stories Table ([PR#419](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/419))
* Added Instructions for Manual testing ([PR#505](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/505))
* Added Effort Section ([PR#503](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/503))
* Updating and fixing bugs in DG ([PR#36](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/36),[PR#278](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/278), [PR#281](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/281), [PR#287](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/287), [PR#319](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/319), [PR#334](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/334), [PR#419](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/419))
* Added User Stories and Use Cases in DG ([[PR#79]], [[PR#142]])
* Added NFRs in DG ([[PR#57]])
* Added implementation details of the `newtag` and `tag` feature. ([[PR#230]], [[PR#464]])
* DG User Stories Table ([[PR#419]])
* Added Instructions for Manual testing ([[PR#505]])
* Added Effort Section ([[PR#503]])
* Updating and fixing bugs in DG ([[PR#36]],[[PR#278]], [[PR#281]], [[PR#287]], [[PR#319]], [[PR#334]], [[PR#419]])

* **Community**:

* PRs reviewed (with non-trivial review comments): [\#199](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/199), [\#32](), [\#232](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/232), [\#143](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/143)

* PRs reviewed (with non-trivial review comments): [\#199](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/199), [\#32](), [\#232](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/232), [\#143](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/143)
56 changes: 28 additions & 28 deletions docs/team/ferusel.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,31 +53,31 @@ Given below are my contributions to the project.
* \_{you can add/remove categories in the list above}

* **PRs**:
* Add PPP skeleton ([PR#64](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/64))
* Add profile picture ([PR#67](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/67))
* Add User Guide section ([PR#82](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/82))
* Rename ferusel.jpg to ferusel.png ([PR#85](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/85))
* Add Glossary, UC3, UC4 to Developer Guide ([PR#87](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/87))
* Add Ting Kai information to AboutUs ([PR#98](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/98))
* Add Item model ([PR#143](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/143))
* Add Item Unit Tests ([PR#155](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/155))
* Add Sort Command ([PR#158](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/158))
* Add Increment and Decrement Command ([PR#161](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/161))
* Add Acknowledgements section to User Guide ([PR#162](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/162))
* Add Glossary section to User Guide ([PR#163](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/163))
* Add Glossary section to Developer Guide ([PR#164](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/164))
* Add View command ([PR#209](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/209))
* Add Sorting user stories to DG ([PR#210](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/210))
* Add Sort Command UML ([PR#232](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/232))
* Update UG with v1.3 Features ([PR#258](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/258))
* Consolidate UG v1.3 ([PR#264](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/264))
* Update Developer Guide with v1.3 ([PR#295](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/295))
* Update README with v1.3 items ([PR#311](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/311))
* Update UG after Refactoring ([PR#318](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/318))
* Fix find command description in Command Summary ([PR#324](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/324))
* Improve UG for v1.3 ([PR#335](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/335))
* Fix UG after Peer Review ([PR#351](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/351))
* Add Statistics Command ([PR#360](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/360))
* Update find command ([PR#367](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/367))
* Website Hot Fix ([PR#369](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/369))
* Fix stats command ([PR#372](https://github.com/AY2223S1-CS2103T-W16-2/tp/pull/372))
* Add PPP skeleton ([[PR#64]])
* Add profile picture ([[PR#67]])
* Add User Guide section ([[PR#82]])
* Rename ferusel.jpg to ferusel.png ([[PR#85]])
* Add Glossary, UC3, UC4 to Developer Guide ([[PR#87]])
* Add Ting Kai information to AboutUs ([[PR#98]])
* Add Item model ([[PR#143]])
* Add Item Unit Tests ([[PR#155]])
* Add Sort Command ([[PR#158]])
* Add Increment and Decrement Command ([[PR#161]])
* Add Acknowledgements section to User Guide ([[PR#162]])
* Add Glossary section to User Guide ([[PR#163]])
* Add Glossary section to Developer Guide ([[PR#164]])
* Add View command ([[PR#209]])
* Add Sorting user stories to DG ([[PR#210]])
* Add Sort Command UML ([[PR#232]])
* Update UG with v1.3 Features ([[PR#258]])
* Consolidate UG v1.3 ([[PR#264]])
* Update Developer Guide with v1.3 ([[PR#295]])
* Update README with v1.3 items ([[PR#311]])
* Update UG after Refactoring ([[PR#318]])
* Fix find command description in Command Summary ([[PR#324]])
* Improve UG for v1.3 ([[PR#335]])
* Fix UG after Peer Review ([[PR#351]])
* Add Statistics Command ([[PR#360]])
* Update find command ([[PR#367]])
* Website Hot Fix ([[PR#369]])
* Fix stats command ([[PR#372]])
Loading

0 comments on commit eff9826

Please sign in to comment.