Skip to content

Commit

Permalink
Merge pull request #186 from McNaBry/add-rec-ug
Browse files Browse the repository at this point in the history
Change link to associate for add recruiter
  • Loading branch information
McNaBry authored Nov 13, 2023
2 parents 0a439ab + 2011019 commit fac0604
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,30 +353,32 @@ add --rec --name NAME [-id ID] [--oid ORG_ID] [--phone NUMBER] [--email EMAIL] [

* When adding in parameters, be aware of the [accepted parameters](#appendix-a-acceptable-values-for-parameters).
* If an `ID` is not specified, one will be automatically generated.
* To link a <span class="jobby-data-class">Recruiter</span> to an <span class="jobby-data-class">Organization</span> in the contacts list, make sure you include `--oid` and pass in the `ID` of the <span class="jobby-data-class">Organization</span> you want to link to.
* If a <span class="jobby-data-class">Recruiter</span> is associated to an <span class="jobby-data-class">Organization</span> in the contacts list, make sure you include `--oid` and pass in the `ID` of the <span class="jobby-data-class">Organization</span> that is associated with the <span class="jobby-data-class">Recruiter</span> you are adding.

##### Sample demonstration
* If you execute the command: `add --rec --name Ryan Koh --oid job_seeker_plus`, you should see a new <span class="jobby-data-class">Recruiter</span> being added to the bottom of the contacts list.

* The newly added contact will have a special label _from organization (job\_seeker\_plus)_ to indicate that the <span class="jobby-data-class">Recruiter</span> is linked to the <span class="jobby-data-class">Organization</span> with that particular `ID`.
* The newly added contact will have a special label _from organization (job\_seeker\_plus)_ to indicate that the <span class="jobby-data-class">Recruiter</span> is associated to the <span class="jobby-data-class">Organization</span> with that particular `ID`.

![add-recruiter](images/add_recruiter_success.png)
<div style="text-align: center;">
<img src="images/add_recruiter_success.png" width=500 />
</div>

##### Valid examples

| Command | Reason |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| `add --rec --name John Doe` | Adds a recruiter that is not linked to any organization. |
| `add --rec --name John Doe --tag friendly --tag woogle` | Adds a recruiter with two tags - friendly and woogle. |
| `add --rec --name John Doe --oid job_seeker_plus` | Adds a recruiter that is linked to an organization (if it exists in the address book) with the id **job_seeker_plus**. |
| `add --rec --name John Doe --id johndoe_123 --oid job_seeker_plus --number 912832192 --email [email protected] --url example.com --address 21 Kent Ridge Rd --tag network` | Adds a recruiter with all the possible fields. |
| Command | Reason |
|-------|----------|
| `add --rec --name John Doe` | Adds a recruiter that is not associated to any organization. |
| `add --rec --name John Doe --tag friendly --tag woogle` | Adds a recruiter with two tags - friendly and woogle. |
| `add --rec --name John Doe --oid job_seeker_plus` | Adds a recruiter that is associated to an organization (if it exists in the address book) with the id **job_seeker_plus**. |
| `add --rec --name John Doe --id johndoe_123 --oid job_seeker_plus --number 912832192 --email [email protected] --url example.com --address 21 Kent Ridge Rd --tag network` | Adds a recruiter with all the possible fields. |

##### Invalid examples

| Command | Reason |
|---------------------------------------------|--------------------------------------------------------------------------------|
| `add --rec` | Missing a name. |
| `add --rec --name John Doe --phone` | Optional fields (in this case `--phone`) were used but not specified. |
| Command | Reason |
|---------|--------|
| `add --rec` | Missing a name. |
| `add --rec --name John Doe --phone` | Optional fields (in this case `--phone`) were used but not specified. |
| `add --rec --name John Doe --oid bogus-org` | Given that no organization with the id "bogus-org" exists in the address book. |


Expand Down

0 comments on commit fac0604

Please sign in to comment.