Skip to content

Commit

Permalink
[Documentation] Edit UG,DG, add Portfolio (#81)
Browse files Browse the repository at this point in the history
* Update docs/team/adrian.adoc

* Add portfolio
UserGuide fixes

* Typos

* Add portfolio to AboutUs.adoc
  • Loading branch information
QzSG authored and GSzQ committed Oct 24, 2018
1 parent 1f3cf2c commit a1cfa0e
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We are a team based in the http://www.comp.nus.edu.sg[School of Computing, Natio
//TODO: Portfolio for everyone
=== Adrian Tan Guo Hua
image::qzsg.png[width="150", align="left"]
{empty}[https://qz.sg[homepage]] [https://github.com/qzsg[github]]
{empty}[https://qz.sg[homepage]] [https://github.com/qzsg[github]] [<<adrian#, portfolio>>]

Role: Team Lead, Developer, Git Expert +
Responsibilities: Devops, Integration, Scheduling and tracking
Expand Down
8 changes: 3 additions & 5 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ There is no need to save manually.
Alert user when a deadline is due

// tag::databackup[]
=== Backup data :`backup`
=== Backup data : `backup`

Allow user to backup data _locally_ or to online services.

Expand All @@ -294,7 +294,7 @@ Creates an online backup to GitHub Gists using the provided personal access toke
// end::databackup[]

// tag::datarestore[]
=== Restore data :`restore`
=== Restore data : `restore`

Allow user to restore data backups _locally_ or from online services.

Expand All @@ -312,13 +312,11 @@ Restores Student Planner data using local backup in default backup path inside `
Restores Student Planner data using the provided backup file path `C:\backup\backup.bak`.
* `restore github ACCESS_TOKEN_HERE` +
Restores Student Planner data on GitHub Gists using the provided personal access token.
// end::databackup[]


=== Setup or restore backup data `[coming in v1.3]`
Allow user to setup backup settings (setup cloud services like GitHub gists or Google Drive, backup location) by calling `backup doctor`

// end::databackup[]
// end::datarestore[]

// tag::dataencryption[]
=== Encrypting data files `[coming in v2.0]`
Expand Down
71 changes: 71 additions & 0 deletions docs/team/adrian.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
= Adrian Tan - Project Portfolio
:site-section: AboutUs
:imagesDir: ../images
:stylesDir: ../stylesheets

== Role: Team Lead, Developer, Git Expert

Responsibilities: Devops, Integration, Scheduling and tracking

== PROJECT: Student Planner

---

== Overview

Student Planner is a all-in-one desktop manager application that allows students to manage their contacts, tasks, events and expenses. 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.

== Summary of contributions

* *Major enhancement*: added *the ability to backup/restore user data*
** What it does: allows the user to backup current user data both online and locally. Backups can be restored by using the restore command.
** Justification: This feature improves the product significantly because a user may have the app on many desktops and this provides a convenient way to synchronise them among many devices.
** Highlights: This enhancement enables a generic class that can be easily extended by developers to support more types of online backup services in future. It requires an in-depth analysis of design alternatives. The implementation too was challenging as the backing up of data online may take a long time, existing implementation will cause the application to freeze until any backup is completed. The current implementation exhibits a working knowledge of multithreading applications as well as event based asynchronous callbacks.
** Credits: GitHub Api by kohsuke.

* *Minor enhancement*: added a user prefences command that allows the user to customise their application preferences such as default backup locations, online backup data location and other application settings.

* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_

* *Other contributions*:

** Project management:
*** Managed all releases on GitHub
*** Setup and modified most of the initial documentation prior to v1.1
** Enhancements to existing features:
*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34])
*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38])
** Documentation:
*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14]
** Community:
*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42]
*** Contributed to forum discussions (examples: https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4])
*** Reported bugs and suggestions for other teams in the class (examples: https://github.com[1], https://github.com[2], https://github.com[3])
*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2])
** Tools:
*** Integrated a third party library (Github Api by kohsuke) to the project (https://github.com/kohsuke/github-api)
*** Integrated a new Github App (Travis.com) to the team repo
**** This is different from other teams still using the old deprecated OAuth Flow used on the older Travis.org domain

_{you can add/remove categories in the list above}_

== Contributions to the User Guide


|===
|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
|===

include::../UserGuide.adoc[tag=databackup]

include::../UserGuide.adoc[tag=datarestore]

== Contributions to the Developer Guide

|===
|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
|===

include::../DeveloperGuide.adoc[tag=backuprestore]

include::../DeveloperGuide.adoc[tag=dataencryption]

0 comments on commit a1cfa0e

Please sign in to comment.