Merge pull request #4764 from cielf/user_docs_cont_viii

User docs cont viii

Author: awwaiid

docs/user_guide/bank/account_management.md

@@ -1,26 +1,29 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
 # Account Management
 
 ## Logging out
 You can log out be clicking your name in the top right corner, then clicking 'Log out'.
 
-[TODO: Navigational screenshot]
-
+![Navigating to log out](images/account_management/account_management_logout.png)
 
 ## Account settings
 You can change your name, email, and password in account settings.  Any of these changes will need your current password.
 Click your name in the top right corner,  then "Account Settings"
-[TODO:  Navigational screenshot]
+![Navigating to account settings](images/account_management/account_management_account_settings_navigation.png)
 Provide your updated information, including your current password,  then click save.
 If you want to change your password, you can do it here -- click the Change Password section to show the new password and confirmation fields.
-[TODO: screen shot]
-[TODO:  Actually test this out.  *I've* never used it.]
+![Account settings screen](images/account_management/account_management_account_settings.png)
 
-Then click save.
+hen click save.
 
 ## My organization
-If you are an org admin,  you can also manage your organization and users through the top-right menu.  This goes to the same screen as clicking on "My Organization" in the left-hand menu.  For details, see [Customization](getting_started_customization.md) and [User Management](user_management.md)
-[TODO:  Add switching to partner ]
+If you are an org admin,  you can also manage your organization and users through the top-right menu, by clicking on your name, then "My Organization"
+![Navigating to My Organization](images/account_management/account_management_my_organization.png)
+This goes to the same screen as clicking on "My Organization" in the left-hand menu.  For details, see [Customization](getting_started_customization.md#basic-information) and [User Management](user_management.md)
+
+## Switching to another role
+You may have an id that works with multiple banks, or, more commonly, with a bank and a Partner.  To switch between these,  click on your name in the top right corner,  then the name of the organizaation (bank or Partner) that you want to switch to.
+
 
 
 

docs/user_guide/bank/community_donation_sites.md

@@ -1,23 +1,24 @@
+READY FOR REVIEW
 # Donation Sites
 
-Donation sites are places where people drop off donations. 
+Donation Sites are places where people drop off Donations. 
 
-## The donation site list
+## The Donation Site list
 You can manage the sites' information on the "Donation Sites" page under the "Community" section. 
 
 ![Donation Sites](images/community/donation_sites/donation_sites.jpg)
 
-Previously recorded information about donation sites appears on this page including the name of the donation site name, address, contact name, e-mail and phone number.
+Previously recorded information about Donation Sites appears on this page including the name of the Donation Site name, address, contact name, e-mail and phone number.
 
 ### Adding a Donation Site
 
-Create a new site by populating the donation site, address, contact name, e-mail and phone fields and clicking the "Create" button. 
+Create a new site by populating the Donation Site, address, contact name, e-mail and phone fields and clicking the "Create" button. 
 
 ![Create Donation_Site](images/community/donation_sites/create_donation_site.jpg)
 
-Note that the donation site and address fields are mandatory while the contact name, email and phone are optional.
+Note that the Donation Site and address fields are mandatory while the contact name, email and phone are optional.
 
-You can also use the "+ New Donation Site" button which renders a form for you to fill in details of a new donation site.
+You can also use the "+ New Donation Site" button which renders a form for you to fill in details of a new Donation Site.
 
 
 ![Add Donation_Site](images/community/donation_sites/add_new_donation_site.jpg)
@@ -26,27 +27,27 @@ After saving the site's details there will be a new row on the Donation Sites pa
 
 ## Viewing Donation Site information
 
-Clicking on the "view" button beside a donation site will show detailed information for that site, including the donation site name, address, contact name, e-mail, phone number, storage location. It also shows a list of the donations for that site including the quantity of items and variety of items. You can drill down to see the full details of each donation by clicking "View donation details".
+Clicking on the "view" button beside a Donation Site will show detailed information for that site, including the Donation Site name, address, contact name, e-mail, phone number, storage location. It also shows a list of the Donations for that site including the quantity of items and variety of items. You can drill down to see the full details of each Donation by clicking "View Donation details".
 
 ![Donation Sites Details](images/community/donation_sites/donation_sites_details.jpg)
 
 ## Editing Donation Site information
 
-Clicking on the "Edit" button beside a donation site in the donation site list lets you edit the name, address, contact name, email and phone number.
+Clicking on the "Edit" button beside a Donation Site in the Donation Site list lets you edit the name, address, contact name, email and phone number.
 
 ![Edit Donation Site Details](images/community/donation_sites/edit_donation_site.jpg)
 
 ## Deactivating a Donation Site
 
-Use the "Deactivate" button to delete information about a donation site that is no longer active.
+Use the "Deactivate" button to hide a Donation Site that is no longer active.
 
 ##### (NB) at time of writing there is no way for you to undo this.
 
 ![Deactivate Donation Sites](images/community/donation_sites/deactivate_donation_site.jpg)
 
 ## Exporting Donation Sites
 
-You can export the active donation sites by clicking on the "Export Donation Sites" button. This will provide a .csv file containing the name, address, and contact information for each active donation site.
+You can export the active Donation Sites by clicking on the "Export Donation Sites" button. This will provide a .csv file containing the name, address, and contact information for each active Donation Site.
 
 ![Export Donation Sites](images/community/donation_sites/export_donation_sites.jpg)
 

docs/user_guide/bank/community_manufacturers.md

@@ -1,25 +1,26 @@
+READY FOR REVIEW
 # Manufacturers
 
-The Manufacturers page under the "Community" section lets you track donations from manufacturers.
+The Manufacturers page under the "Community" section lets you manage your Manufacturers and track donations from them.
 
 ![Manufacturers](images/community/manufacturers/manufacturers_page.jpg)
 
-It shows the name and total items donated by a manufacturer.
+It shows the name and total Items donated by a Manufacturer.
 
 ### Adding a manufacturer
 
-Click on the "+ New Manufacturer" button, to add the manufacturer's name.
+Click on the "+ New Manufacturer" button, to add the Manufacturer's name.
 
 ![New Manufacturer](images/community/manufacturers/new_manufacturer.jpg)
 
-## Viewing manufacturer information
+## Viewing Manufacturer information
 
-Click on "View" for more details about the manufacturer which shows the date of each donation, volume (total items in the donation), and lets you view the full details of each donation.
+Click on "View" for more details about the Manufacturer which shows the date of each donation, volume (total items in the donation), and lets you view the full details of each donation.
 
 ![Manufacturer Details](images/community/manufacturers/manufacturer_details.jpg)
 
 ## Editing manufacturer information
 
-Click the "Edit" button to edit the manufacturer's name.
+Click the "Edit" button to edit the Manufacturer's name.
 
 [Prior: Vendors](community_vendors.md)[Next: Exports](exports.md)

docs/user_guide/bank/community_product_drive_participants.md

@@ -1,12 +1,13 @@
+READY FOR REVIEW
 # Product Drive Participants
 
-If you conduct product drives, the product drive participants list lets you manage the participant's contact information and see their donation history.
+If you conduct Product Drives, the Product Drive Participants list lets you manage the participant's contact information and see their Donation history.
 
-To manage product drive participants, click on "Product Drive Participants" under the "Community" section.
+To manage Product Drive Participants, click on "Product Drive Participants" under the "Community" section.
 
 ![Product Drive Participants](images/community/product_drive_participants/product_drive_page.jpg)
 
-This page lists some basic details from all previously entered product drive participants -- business, contact, phone email, and total items, letting you drill down to more information, or to edit each participant's information.
+This page lists some basic details from all previously entered Product Drive Participants -- business, contact, phone email, and total items, letting you drill down to more information, or to edit each participant's information.
 
 ## Adding participants
 
@@ -16,13 +17,12 @@ To add a new participant, click on the "+ New Product Drive Participant" button,
 
 After saving the participant's details there will be a new row in the Product Drive Participants page.
 
-You can also add new participants "on the fly" as you enter the donations, through the [New Donation](essentials_donations.md) page.
+You can also add new participants "on the fly" as you enter the donations, through the [New Donation](essentials_donations.md#new-donations) page.
 
-[TODO: link to new donations ]
 
 ## Viewing participant information
 
-Click on "View" for more details about the product drive participant which also shows the date of each donation, volume, and donations details.
+Click on "View" for more details about the Product Drive Participant which also shows the date of each Donation, volume, and Donation details.
 
 ![Participant Details](images/community/product_drive_participants/participant_details.jpg)
 
@@ -34,7 +34,7 @@ Click the "Edit" button to edit the participant's details.
 
 ## Exporting participants
 
-You can export all the participants by clicking on the "Export Product Drive Paticipants" button.
+You can export all the participants by clicking on the "Export Product Drive Participants" button.
 Currently we are not providing all the participants' details in the export.
 
 ![Export Drive Participants](images/community/product_drive_participants/export_participants.jpg)

docs/user_guide/bank/community_product_drives.md

@@ -1,65 +1,57 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
 # Product Drives
-Many banks hold seasonal or one-off events where they are seeking donations.  In Human Essentials, Product drives help manage those events by providing a way to link specific donations to the events.
+Many banks hold seasonal or one-off events where they are seeking Donations.  In Human Essentials, Product Drives help manage those events by providing a way to link specific Donations to the events.
 
-[TODO:  For consistency, I would remove 'New Product Drive' from the lhs, and change "All Product Drives" to "Product Drives]
+## Product Drives list
+To see all your Product Drives, click on "Community", then "All Product Drives" in the left-hand menu.
 
-## Product drives list
-To see all your product drives, click on "Community", then "All Product Drives" in the left-hand menu.
+![Product Drive navigation](images/community/product_drives/community_product_drives_navigation.png)
 
-This presents a filterable list of all your product drives, including the following fields:
+
+This presents a filterable list of all your Product Drives, including the following fields:
 - Product Drive Name
 - Start Date
 - End Date (this is optional)
 - Held Virtually?
 - Quantity of Items
 - Variety of Items
-- In-Kind Value (TODO:  Fix spelling in header)
+- In-Kind Value 
 - Actions (only view at the moment)
 
-The list initially shows all the product drives starting in the current year. 
-
-[TODO:  NAvigation screenshot]
-
-
+The list initially shows all the Product Drives that are at least partly in our default period of 60 days past to 30 days in the future.
 
-[TODO:  Is that right,  or is it all product drives that are at least partly in the current year?   It probably should be the latter]
-
-### Filtering you product drives list
-The product drives list is filterable by any of the following. 
-- Product drive name
-- Item category
+### Filtering your Product Drives list
+The Product Drives list is filterable by any of the following. 
+- Product Drive name
+- Item Category
 - Date range (by starting date)
 
-[TODO:  confirm how the date range works.]
-
 Provide the information you want to filter by, then click "Filter".  Clicking "Clear Filters"  will return the list to its defaults.
 
-## Adding a product drive
-To add a product drive, either:
+## Adding a Product Drive
+To add a Product Drive, either:
 a) click "Community", then "New Product Drive" in the left hand menu, or
 b) click "+New Product Drive" in the Product Drives list
-[TODO:  Navigation screenshot]
+![Navigation to New Product Drive](images/community/product_drives/community_product_drives_add_navigation.png)
 
-Either will bring up this screen, which contains all the fields you can specify for a new product drive:
+Either will bring up this screen, which contains all the fields you can specify for a new Product Drive:
 - Name
 - Start Date
 - End Date (this is optional)
 - Product Drive is Virtual? (check this if it's a virtual drive)
 
-[TODO: Screenshot]
-[TODO:  Styling of "Create product drive" -- button should be white on green] 
+![+New Product Drives page](images/community/product_drives/community_product_drives_add.png)
 
-## Viewing your product drive
-To view a specific product drive, click the "View" button beside it in the product drives list.
-[TODO: Navigational Screenshot]
-[TODO: Screenshot]
-This will bring up the product drive view, which includes informtation about both the donations for the product drive, and the participants in the drive, in addition to the basic information about the product drive itself.
+## Viewing a Product Drive
+To view a specific Product Drive, click the "View" button beside it in the Product Drives list.
+![Navigation to view a Product Drive](images/community/product_drives/community_product_drives_view_navigation.png)
+
+This will bring up the Product Drive view, which includes information about both the Donations for the Product Drive, and the participants in the drive, in addition to the basic information about the drive itself.
+![Product Drive view page](images/community/product_drives/community_product_drives_view.png)
 Basic info:
 - Name
 - Start Date
 - End Date
-[TODO:  Move the "Make a correction" button up to below the basic information, not below the donations]
 Information about each donation:
 - Donation ID -- this is a number the system applies to each donation
 - Product Drive Participant
@@ -72,25 +64,27 @@ For each product drive participant associated with this product drive:
 - Phone
 - Email
 - Address
-- Items for this Drive (number of items for this drive)
+- Items for this drive (number of Items for this drive)
 - Total Items (for all drives)
 - Comment
 
-You can also make a correction to your product drive or delete it from this page.
+You can also make a correction to your Product Drive or delete it from this page.
+
+[!CAUTION] DO NOT DELETE your Product Drive if it has Donations in it.  It will not go well.  We have an outstanding issue to block you doing that.
 
-#### NB -- DO NOT DELETE your product drive if it has donations in it.  It will not go well.
+##  Modifying your Product Drive
+If you want to edit the base information in a Product Drive, you can do that by clicking "Community", then "All Product Drives" in the left-hand menu,  then clicking "View" beside the product drive you wish to modify, and then clicking "Make a correction".
+![Navigation to update Product Drive](images/community/product_drives/community_product_drives_modify_navigation.png)
 
-##  Modifying your product drive
-If you want to edit the base information in a product drive, you can do that by clicking "Community", then "All Product Drives" in the left-hand menu,  then clicking "View" beside the product drive you wish to modify, and then clicking "Make a correction".
-This will bring up the basic information for your product drive,  You can rename it, change the dates, or change whether it is a virtual drive.
-Then click "Update Product drive" to save your changes.
+This will bring up the basic information for your Product Drive,  You can rename it, change the dates, or change whether it is a virtual drive.
+Then click "Update Product Drive" to save your changes.
 
-[TODO: Screenshot]
+![Modify Product Drive page](images/community/product_drives/community_product_drives_modify.png)
 
-## Exporting product drives
-To export your currently filtered product drives,  click "Export product drives" on the Product Drives List
+## Exporting Product Drives
+To export your currently filtered Product Drives,  click "Export Product Drives" on the Product Drives List
+![Navigation to Product Drive export](images/community/product_drives/community_product_drives_export_navigation.png)
 
-[TODO:  Navigation Screenshot]
 
 [Prior: Transfers](inventory_transfers.md)
 [Next: Product Drive Participants](community_product_drive_participants.md)