Merge pull request #468 from RichDom2185/week13/remove-code-duplicati…

…on-and-update-ppp Remove code duplication and update PPP intro
AY2223S1-CS2103T-W16-2 · Nov 5, 2022 · f611f49 · f611f49
2 parents eb08cb8 + 5d963dd
commit f611f49
Show file tree

Hide file tree

Showing 12 changed files with 57 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -5,8 +5,10 @@
 
 ## FoodRem
 
+<!-- TODO: Check that this matches {{ site.data.foodrem.about.summary }} -->
 FoodRem is an Inventory Management System that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's Inventory Management System during your daily operations. Utilize FoodRem's flexible tagging system to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's statistics, keeping track of vital data such as food wastage.
 
 ## Acknowledgements
 
+<!-- TODO: Check that this matches {{ site.data.foodrem.acknowledgements }} -->
 FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore.
diff --git a/docs/_data/foodrem.yml b/docs/_data/foodrem.yml
@@ -0,0 +1,13 @@
+acknowledgements: >-
+  FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/),
+  taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html)
+  held by the School of Computing at the National University of Singapore.
+
+about:
+  summary: >-
+    FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers
+    to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's
+    own **Inventory Management System**, where you can manage your inventory during your daily operations. Utilize
+    FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs.
+    Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's
+    **statistics**, keeping track of vital data such as food wastage.
diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml
diff --git a/docs/_dg/Acknowledgements.md b/docs/_dg/Acknowledgements.md
@@ -1,5 +1,6 @@
 <!--markdownlint-disable-file first-line-h1 -->
-FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.acknowledgements }}
 
 * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/)
 * Icons used: Icons for [FoodRem](https://mdi.bessarabov.com/icon/food-turkey), [admonitions](http://glyphicons.com/)
diff --git a/docs/_layouts/ppp.html b/docs/_layouts/ppp.html
@@ -0,0 +1,4 @@
+---
+layout: page
+---
+{{ content }}
diff --git a/docs/_ug/About.md b/docs/_ug/About.md
@@ -1,5 +1,6 @@
 <!-- markdownlint-disable-file first-line-h1 -->
-FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, leverage upon FoodRem's own **Inventory Management System**, where you can manage your inventory during your daily operations. Utilize FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's **statistics**, keeping track of vital data such as food wastage.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 Simply by typing, efficiently interact with FoodRem without ever needing to touch your mouse! With a focus on user-friendliness, FoodRem is easy to learn!
 

diff --git a/docs/_ug/Acknowledgements.md b/docs/_ug/Acknowledgements.md
@@ -1,5 +1,6 @@
 <!-- markdownlint-disable-file first-line-h1 -->
-FoodRem is a brownfield software project based off [AddressBook3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.acknowledgements }}
 
 * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/)
 * Icons used: [FoodRem Logo](https://mdi.bessarabov.com/icon/food-turkey), [Admonition Icons](http://glyphicons.com/)
diff --git a/docs/team/bryanljx.md b/docs/team/bryanljx.md
@@ -1,42 +1,43 @@
 ---
-layout: page
+layout: ppp
 title: Bryan Lim Jing Xiang's Project Portfolio Page
 ---
 
-### Project: AddressBook Level 3
+<!-- markdownlint-disable-next-line blanks-around-headers -->
+### Project: FoodRem
+{: .no_toc}
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 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))
   * 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))
   * 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))
   * 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))
   * 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))
   * 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`.
 
-
 * **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=bryanljx&tabRepo=AY2223S1-CS2103T-W16-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
 
 * **Enhancements to existing features**:

diff --git a/docs/team/eugenetanwl3881.md b/docs/team/eugenetanwl3881.md
@@ -1,11 +1,14 @@
 ---
-layout: page
+layout: ppp
 title: Eugene Tan's Project Portfolio Page
 ---
 
-### Project: AddressBook Level 3
+<!-- markdownlint-disable-next-line blanks-around-headers -->
+### Project: FoodRem
+{: .no_toc}
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 Given below are my contributions to the project.
 

diff --git a/docs/team/ferusel.md b/docs/team/ferusel.md
@@ -1,11 +1,14 @@
 ---
-layout: page
+layout: ppp
 title: Mai Ting Kai's Project Portfolio Page
 ---
 
-### Project: AddressBook Level 3
+<!-- markdownlint-disable-next-line blanks-around-headers -->
+### Project: FoodRem
+{: .no_toc}
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 Given below are my contributions to the project.
 

diff --git a/docs/team/richdom2185.md b/docs/team/richdom2185.md
@@ -1,11 +1,14 @@
 ---
-layout: page
+layout: ppp
 title: Richard Dominick's Project Portfolio Page
 ---
 
-### Project: AddressBook Level 3
+<!-- markdownlint-disable-next-line blanks-around-headers -->
+### Project: FoodRem
+{: .no_toc}
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 Given below are my contributions to the project.
 

diff --git a/docs/team/yixiann.md b/docs/team/yixiann.md
@@ -1,11 +1,14 @@
 ---
-layout: page
+layout: ppp
 title: Tan Yi Xian's Project Portfolio Page
 ---
 
-### Project: AddressBook Level 3
+<!-- markdownlint-disable-next-line blanks-around-headers -->
+### Project: FoodRem
+{: .no_toc}
 
-AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+<!-- markdownlint-disable-next-line proper-names -->
+{{ site.data.foodrem.about.summary }}
 
 Given below are my contributions to the project.