gig-central / gig-repo-1

Our main Gig Central Repo
Apache License 2.0
4 stars 11 forks source link

Revamping the installation document #310

Open SekllanChenRuan opened 4 years ago

SekllanChenRuan commented 4 years ago

_MASTER TEMPLATE: Use for bugs, tasks, and future requests. Also, label accordingly, using the labels on the right.

_Issue Type - is it a bug, a task, or a future request?:

Task

_Severity (1-4; 1 - not severe, 4 - very severe):

3

_Priority (1-4; 1 - lowest priority, 4 - highest priority):

3

_Synopsis - describe bug/task/future request, in more detail:

The current installation document is slightly outdated and confusing. This is why I will attempt to revamp the document to be more clear and up to date.

_Expected Behavior - what the behavior is supposed to be, for bug/task/FR:

The expected behavior is a document that guides the installation of gig-central with ease and little to no trouble.

_Actual Behavior - what the behavior is instead, for bugs only:

Through my personal experience and others in my class or team, I realized the current installation document is confusing in guiding the installation process. Some have had to delete the whole gig-central and redo the process over again. This is the fault of the installation document that is being unclear.

_Steps to Repro the Issue, for bugs only:

_Other Notes, for bug/task/future requests: