rubyforgood · awwaiid · Jul 28, 2024 · Jul 22, 2024 · Jul 28, 2024
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -792,4 +792,4 @@ DEPENDENCIES
   webmock (~> 3.23)
 
 BUNDLED WITH
-   2.5.14
+   2.5.16
diff --git a/doc/user_guide/bank/essentials_dashboard.md b/doc/user_guide/bank/essentials_dashboard.md
diff --git a/doc/user_guide/bank/getting_started_customization.md b/doc/user_guide/bank/getting_started_customization.md
diff --git a/doc/user_guide/bank/getting_started_donation_sites.md b/doc/user_guide/bank/getting_started_donation_sites.md
diff --git a/doc/user_guide/bank/getting_started_inventory.md b/doc/user_guide/bank/getting_started_inventory.md
diff --git a/doc/user_guide/bank/getting_started_user_management.md b/doc/user_guide/bank/getting_started_user_management.md
diff --git a/doc/architecture/barcode-retrieval.svg → docs/architecture/barcode-retrieval.svg b/doc/architecture/barcode-retrieval.svg → docs/architecture/barcode-retrieval.svg
diff --git a/...ons/0001-record-architecture-decisions.md → ...ons/0001-record-architecture-decisions.md b/...ons/0001-record-architecture-decisions.md → ...ons/0001-record-architecture-decisions.md
diff --git a/...models-as-they-move-through-the-system.md → ...models-as-they-move-through-the-system.md b/...models-as-they-move-through-the-system.md → ...models-as-they-move-through-the-system.md
diff --git a/...itenancy-instead-of-multiple-instances.md → ...itenancy-instead-of-multiple-instances.md b/...itenancy-instead-of-multiple-instances.md → ...itenancy-instead-of-multiple-instances.md
diff --git a/...rate-application-intended-for-partners.md → ...rate-application-intended-for-partners.md b/...rate-application-intended-for-partners.md → ...rate-application-intended-for-partners.md
diff --git a/...06-instantiating-items-from-base-items.md → ...06-instantiating-items-from-base-items.md b/...06-instantiating-items-from-base-items.md → ...06-instantiating-items-from-base-items.md
diff --git a/...ecture/decisions/0007-barcode-querying.md → ...ecture/decisions/0007-barcode-querying.md b/...ecture/decisions/0007-barcode-querying.md → ...ecture/decisions/0007-barcode-querying.md
diff --git a/...8-merging-partner-base-and-diaper-base.md → ...8-merging-partner-base-and-diaper-base.md b/...8-merging-partner-base-and-diaper-base.md → ...8-merging-partner-base-and-diaper-base.md
diff --git a/...009-stick-with-adminlte-for-app-design.md → ...009-stick-with-adminlte-for-app-design.md b/...009-stick-with-adminlte-for-app-design.md → ...009-stick-with-adminlte-for-app-design.md
diff --git a/doc/architecture/decisions/README.md → docs/architecture/decisions/README.md b/doc/architecture/decisions/README.md → docs/architecture/decisions/README.md
diff --git a/doc/architecture/multi-tenancy.svg → docs/architecture/multi-tenancy.svg b/doc/architecture/multi-tenancy.svg → docs/architecture/multi-tenancy.svg
diff --git a/doc/architecture/overview.md → docs/architecture/overview.md b/doc/architecture/overview.md → docs/architecture/overview.md
diff --git a/doc/architecture/partner-request.svg → docs/architecture/partner-request.svg b/doc/architecture/partner-request.svg → docs/architecture/partner-request.svg
diff --git a/doc/architecture/physical-flow.svg → docs/architecture/physical-flow.svg b/doc/architecture/physical-flow.svg → docs/architecture/physical-flow.svg
diff --git a/doc/architecture/timeline-flow.svg → docs/architecture/timeline-flow.svg b/doc/architecture/timeline-flow.svg → docs/architecture/timeline-flow.svg
diff --git a/doc/templates/release-template.md → docs/templates/release-template.md b/doc/templates/release-template.md → docs/templates/release-template.md
diff --git a/doc/user_guide/bank/asking_for_changes.md → docs/user_guide/bank/asking_for_changes.md b/doc/user_guide/bank/asking_for_changes.md → docs/user_guide/bank/asking_for_changes.md
diff --git a/...er_guide/bank/community_donation_sites.md → ...er_guide/bank/community_donation_sites.md b/...er_guide/bank/community_donation_sites.md → ...er_guide/bank/community_donation_sites.md
diff --git a/...ser_guide/bank/community_manufacturers.md → ...ser_guide/bank/community_manufacturers.md b/...ser_guide/bank/community_manufacturers.md → ...ser_guide/bank/community_manufacturers.md
diff --git a/...er_guide/bank/community_product_drives.md → ...er_guide/bank/community_product_drives.md b/...er_guide/bank/community_product_drives.md → ...er_guide/bank/community_product_drives.md
diff --git a/doc/user_guide/bank/community_vendors.md → docs/user_guide/bank/community_vendors.md b/doc/user_guide/bank/community_vendors.md → docs/user_guide/bank/community_vendors.md
diff --git a/docs/user_guide/bank/essentials_dashboard.md b/docs/user_guide/bank/essentials_dashboard.md
@@ -0,0 +1,28 @@
+DRAFT USER GUIDE
+# Your Dashboard
+When you log in, your initial screen will be a dashboard with information that is useful on a daily basis for most banks.
+
+If you haven't finished setting up your bank in the system,  the "getting started" steps (as described in an earlier section) will appear.
+
+Otherwise, there are 4 sections to the dashboard: announcements, outstanding requests, partner approvals, and bank-wide low inventory. 
+
+![top of dashboard page](images/essentials/dashboard/essentials_dashboard_1.png)
+
+#### Announcements
+This section is announcements from the human resources team.  This is where we tell you what changes there have been in the latest release, and let everyone know about any significant issues with the system that affect everybody (with workarounds, if we can.)
+Look for new info here every Monday - as we put out new releases most Sunday mornings.
+
+#### Outstanding Requests
+This is pretty much what it sounds like - a list of the requests from your partners that have not yet been fulfilled.  You can bring up the details of each request by clicking on the date.
+
+
+![bottom of dashboard page](images/essentials/dashboard/essentials_dashboard_2.png)
+
+#### Partner Approvals
+This lists the partner profiles that have been submitted for approval.  Partners can not submit requests until they have been approved.  To review the application, click on the "Review Application" button beside the partner in the Action colum.  For more details on that, see [Approving a partner](pm_approving_a_partner.md)
+
+#### Bank-wide Low Inventory
+This lists items whose *bank-wide* inventory has fallen below the recommended or minimum quantity levels you have set on the items. If the item's level in inventory across the bank has fallen below the minimum quantity, it will appear in red.
+
+For help on setting those levels, see [Inventory Items](inventory_items.md).  If you haven't set those levels, the items will not appear on this list, even if you have no inventory.
+
diff --git a/...er_guide/bank/essentials_distributions.md → ...er_guide/bank/essentials_distributions.md b/...er_guide/bank/essentials_distributions.md → ...er_guide/bank/essentials_distributions.md
diff --git a/doc/user_guide/bank/essentials_donations.md → docs/user_guide/bank/essentials_donations.md b/doc/user_guide/bank/essentials_donations.md → docs/user_guide/bank/essentials_donations.md
diff --git a/doc/user_guide/bank/essentials_calendar.md → docs/user_guide/bank/essentials_pick_ups.md b/doc/user_guide/bank/essentials_calendar.md → docs/user_guide/bank/essentials_pick_ups.md
@@ -4,31 +4,34 @@ Pick Ups & Deliveries shows scheduled and completed distributions in a calendar
 
 Click on "Pick Ups & Deliveries" in the left-hand menu to view the calendar.
 
-![PickUps & Delivery Calendar](images/pickup&delivery.jpg)
+![PickUps & Delivery Calendar](images/essentials/pick_ups/pickup&delivery.jpg)
 
 Click on any scheduled distribution to view details on all the distributions for that day.
 The Distribution Schedule page shows details including the Partner,the time of distribution, source inventory, the total number of items, and the status of the distribution.
 
-![Specific Day Distribution](images/specific_day_distribution_schedule.jpg)
+![Specific Day Distribution](images/essentials/pick_ups/specific_day_distribution_schedule.jpg)
 
 Once the partner has the distributed goods, clicking "Distribution Complete" changes the status of the distribution from "Scheduled" to "Complete", so you can track what is still in your hands and what is with your partners in the community. It does not, at this time, remove it from the calendar.
 
 Click "View" for details on the distribution's source location, agency representative, delivery method, shipping cost, comments, and state. This also shows a list of items included in the distribution.
 
-![Distribution from Source Inventory to Partner](images/distribution_from_source_to_partner.jpg)
+![Distribution from Source Inventory to Partner](images/essentials/pick_ups/distribution_from_source_to_partner.jpg)
 
 If you want to print the details of the distribution to use as a contents list or receipt, click on "Print".
 
 ## Sync Pick Ups & Deliveries Calendar with Google Calendar
 
 You can sync the Pick Ups & Deliveries Calendar with Google Calendar for more convenience.
 
-Click on "Copy Calendar URL to clipboard" to get the calendar URL to be added to Google calendar. On Google Calendar, in the "Other calendars" section click on the "+" which will bring up several choices.
+From the calendar page, click on "Copy Calendar URL to clipboard" to get the calendar URL to be added to Google calendar.
+![Copy_Calendar_URL](images/essentials/pick_ups/copy_calendar_url.png)
 
-![Other Calendars](images/other_calendars.jpg)
+Then, open your Google Calendar.  On Google Calendar, in the "Other calendars" section click on the "+" which will bring up several choices.
+
+![Other Calendars](images/essentials/pick_ups/other_calendars.jpg)
 
 Select "From URL"and paste the URL you copied in the "URL of calendar" section and click on "Add Calendar"
 
-![Add Calendar](images/add_calendar.jpg)
+![Add Calendar](images/essentials/pickups/add_calendar.jpg)
 
 Events from the Human Essentials Pick Ups & Deliveries Calendar should be accessible to you on Google Calendar when the sync is complete.
diff --git a/doc/user_guide/bank/essentials_purchases.md → docs/user_guide/bank/essentials_purchases.md b/doc/user_guide/bank/essentials_purchases.md → docs/user_guide/bank/essentials_purchases.md
diff --git a/doc/user_guide/bank/essentials_requests.md → docs/user_guide/bank/essentials_requests.md b/doc/user_guide/bank/essentials_requests.md → docs/user_guide/bank/essentials_requests.md
diff --git a/doc/user_guide/bank/exports.md → docs/user_guide/bank/exports.md b/doc/user_guide/bank/exports.md → docs/user_guide/bank/exports.md
diff --git a/...ide/bank/getting_started_access_levels.md → ...ide/bank/getting_started_access_levels.md b/...ide/bank/getting_started_access_levels.md → ...ide/bank/getting_started_access_levels.md
diff --git a/docs/user_guide/bank/getting_started_customization.md b/docs/user_guide/bank/getting_started_customization.md
@@ -0,0 +1,174 @@
+DRAFT USER GUIDE 
+
+# Organization information and customization
+
+Every essentials bank has its own way of doing things. 
+With that in mind, there are a number of things you can tweak. 
+This is done through "My Organization". 
+Only organization admins have access to this area.
+
+## Getting to the organization edit
+
+Scroll down to the bottom of the left-hand menu (you may have to collapse areas that you've opened)to the last item.  Click on "My Organization".
+
+This brings up a view of the organization settings. It shows everything we are going to talk about for the rest of this section, as well as the users (more on them in the next section)
+Scroll down until you see an Edit button.  Click it.
+
+You should now be in a screen that is titled "Editing [Your bank name]"
+
+Here's all the fields, with a bit about the implications of each one:
+
+## Basic Information 
+### Name
+The name of your essentials bank.   This appears in the headings on most screens, and will appear on printouts (such as the distribution printout many banks use as a packing slip), and most reports.
+
+### Short name
+You don't change this -- we assigned it when we set it up -- it's here for reference for support calls if we need it.
+
+### NDBN membership
+This should be filled in already from your account request,but if it isn't, you can select it from the list.   That list is updated on an irregular basis,  so if you are an NDBN member, and you aren't on the list,  let us know and we'll get a fresh list uploaded.
+This is included on the Annual survey report.  That's the only effect.
+
+### Url
+Your essentials bank's website address.  This is mostly used during the account request process, so we can check if you are a good fit before you invest a lot of time and energy into the system.
+
+### Email
+Your essential bank's email address.  This is shown to the partners on their help page, and is included in reminder emails, so please use an email that is monitored.   This email is also included on distribution and donation printouts and the annual survey [TODO:  Confirm each of those.]
+
+### Address
+Your essential bank's primary address.   This is shown on the distribution and donation printouts, and the annual survey [TODO:  Confirm annual survey]
+
+## Reminder Emails (optional)
+You can opt, on a partner by partner basis, to have reminder emails sent.  
+There is also a check-box on the partner that must be checked for the partner to get these emails.
+
+
+The text of this email will be:  
+
+Hello [Partner's name],
+
+This is a friendly reminder that [Your bank's name] requires your human essentials requests to be submitted by [the deadline date, including month and year]
+if you would like to receive a distribution next month.
+
+Please log into Human Essentials at https://humanessentials.app before this date and submit your request if you are intending to submit an essentials request.
+
+Please contact [Your bank's name] at <%= @organization.email %>
+if you have any questions about this!
+
+
+
+
+
+
+### Reminder day (Day of month an e-mail reminder is sent to partners to submit requests)
+ At this point, we send those emails once a month on the day of the month you indicate here.
+If you do not pick a day, no reminder emails are sent.
+
+### Deadline day (Final day of the month to submit requests)
+This day will be included in the reminder email message, 
+
+
+## Default Intake Location
+
+This is the  default storage location for donations and purchases.  
+If you specify this, it will be pre-populated as the storage location when you are adding new donations or purchases.
+
+## Partner Profile Sections
+The [Partner Profile](pm_partner_profiles.md) is a very large form that includes a lot of information.   You might not care about all of it.
+This field lets you specify which of the sub-sections of that form will be used.  
+The Agency Information subsection is always included.
+If you do not specify any sections,  they will all be included.  
+The sections are:  
+- Media Information
+- Agency Stability
+- Organizational Capacity
+- Sources of Funding
+- Area Served
+- Population Served
+- Agency Distribution Information
+- Attached Documents
+
+## Default Storage Location
+
+The bank-wide default storage location for donations and purchases.  
+You can also specify a different default storage location on any partner, which will override this default.
+If you specify a default storage location, it will be pre-populated as the storage location when you are adding new distributions.
+
+## Custom Partner Invitation Message
+[TODO:  Ensure that this is working!] 
+
+When you invite a partner, they get an email.  This field lets you specify the message you are sending to them.  Just text -- we don't have any personalization capability for this email at this time.
+
+If you do not specify a message, the invitation will contain:  
+
+Hello [partner's email]
+
+You've been invited to become a partner with Pawnee Diaper Bank!
+
+Please click the link below to accept your invitation and create an account and you'll be able to begin requesting distributions.
+
+Please contact [bank's email] if you are encountering any issues.
+
+Accept Invitation
+For security reasons these invitations expire. This invitation will expire in 8 hours or if a new password reset is triggered.
+
+If your invitation has an expired message, go here(link to the log in page) and enter your email address to reset your password.
+
+Feel free to ignore this email if you are not interested or if you feel it was sent by mistake.
+
+
+## Questions for the annual survey
+These fields are only here to be reported on the annual survey.
+
+### Does your bank repackage essentials?
+### Does your bank distribute monthly
+
+## Custom Units
+The number of items throughout the bank's view of the system is the number of units (e.g. diapers), but 
+partners often think in terms of packs of diapers.   Because banks were getting a lot of partners requesting the number of packs of diapers, instead of the number of diapers, we have introduced the ability for banks to allow the partners to request other units (e.g. packs)
+
+This deserves a page of it's own - but in short,  you can specify units here, that you can add to your items.   The partners then can ask for, say, 'packs' of diapers.   You will still have to translate those to the number of items when distributing
+Because there is a lot of variety in pack size across brands.
+
+[TODO:  This is actually a good candidate for a video showing the whole process]
+
+## Controlling what kind of request a partner can make
+
+There are three different ways a partner can request essentials -- a "Child based" request, a request by number of individuals, and a straight quantity-based request.  Some banks want to limit which requests the partners can make, in order to minimize partner confusion.
+These three fields allow you to control which requests the partners can use.
+If you allow more than one kind, the partner can also limit their own.
+Note that if any partner limits themselves to a single type,  you won't be able to remove that type.  So, if you think you only want to allow quantity-based requests, doing that up front is a fine idea. 
+
+### Enable partners to make child-based requests
+### Enable partners to make requests for individuals?
+### Enable partners to make quantity-based requests?
+
+## Customizing the distribution printout
+There are four fields that allow you to tweak the appearance of the distribution printout
+
+
+### Show Year-to-date values on the distribution printout? 
+Some banks don't want to show year-to-date values on the receipt (1, below) because their fiscal year is not the calendar year.  
+### Include Signature Lines on Distribution Printout
+If "yes", this will include a space for someone from the bank and from the partner to sign the distribution printout (2, below) - which can be useful as a receipt acknowledgement.
+### Hide both value columns 
+The default is to show the in-kind value of the items on the receipt (3, below).  Many banks don't need to show this information on the distribution printout.
+Note:  Hiding this also hides the corresponding values on the single donation printout. 
+### Hide the package column on distribution receipts?
+This hides the packages column on the distribution printout (4, below).  Because different brands of essentials use different size packages,  this
+column is useful mainly for banks that repackage their essentials into uniform package sizes.  If you have a uniform package size, you can specify that on the item (see [Inventory Items](inventory_items.md))
+
+![distribution printout marked up with customizable sections](images/getting_started/customization/gs_customization_distribution_printout_customizable_sections.png)
+
+## Use One Step Invite and Approve partner process?
+Partners can't submit requests until they are approved by the bank.
+The full partner approval process requires the partner to fill in their profile and submit it for approval.  Some banks handle that for their partners,  gather the information through other means (such as a phone conversation). 
+Checking this will change the process so that the partners are automatically approved when they are invited. Note that any invited partners that are not yet approved will still need to be approved by the bank.
+
+## Distribution Email Content
+Note that there is a checkbox on the partner for them to receive distribution emails.  We recommend you do customize this content, as the default text is abrupt.
+You can customize this quite a bit!  [TODO:  expand.   Maybe provide a real life example.]
+
+## Logo
+
+The logo that you upload here will appear several places throughout the system, including on your distribution and donation printouts.  Larger logos will impact your performace -- the 763 x 188 size is a good guideline.
diff --git a/docs/user_guide/bank/getting_started_donation_sites.md b/docs/user_guide/bank/getting_started_donation_sites.md
@@ -0,0 +1 @@
+Not yet written - we are reviewing the getting started material and donation sites are an optional component.
diff --git a/docs/user_guide/bank/getting_started_inventory.md b/docs/user_guide/bank/getting_started_inventory.md
@@ -0,0 +1,26 @@
+DRAFT USER GUIDE
+# Getting started -- inventory
+When we set up your organization, we provide a default set of items ranging from adult briefs to kids (newborn) 
+to tampons. You can modify this list at any time, through the [Inventory Items](inventory_items.md) feature.  
+This section of the guide will take you through a couple of ways to get your initial inventory in.
+[TODO:  Rewrite once we have audits available as a starting strategy]
+[TODO:  Really -- this should just be inventory adjustment front and center -- but that's not how the system works atm]
+## Adding a past donation
+One easy way to get your current inventory set up is to just enter a donation per storage location with all of the current inventory, and put a 
+comment on it to indicate that this was your starting inventory.  The values you enter there will be included in your donation reports for the year, 
+so if you don't want that, either backdate the donation to the previous year or use the inventory adjustments method, below.
+
+To enter a past donation, simply click on the "Add past donation" button, which takes you to the New Donation screen, which is described in a lot of detail [here](essentials_donations.md)
+
+![navigation to enter_past_donation](images/getting_started/inventory/gs_inventory_1.png)
+
+## Adding a past purchase
+Similarly, if you've started your bank with a purchase of goods, you might want to enter the details as a purchase.  The values you enter here will be included in your purchase reports for the year chosen.
+
+![navigation to enter_past_purchase](images/getting_started/inventory/gs_inventory_2.png)
+## Inventory adjustment
+Another (some say superior) way to set up your bank is through inventory adjustments.  This has the advantage of keeping your initial 
+inventory, however it was acquired, out of donation and purchase reports.  The details on entering an inventory adjustment can be found [here](inventory_adjustments.md)
+
+![navigation to enter new inventory adjustment](images/getting_started/inventory/gs_inventory_3.png)
+
diff --git a/...er_guide/bank/getting_started_partners.md → ...er_guide/bank/getting_started_partners.md b/...er_guide/bank/getting_started_partners.md → ...er_guide/bank/getting_started_partners.md
@@ -17,7 +17,7 @@ DRAFT USER GUIDE
 Click on the "Add a Partner" button on your "Getting started" screen
 (you can also click on "Partner Agencies", then "All Partners", then "Add a Partner")
 
-![navigation](images/gs_just_starting_step_1.png)
+![navigation](images/getting_started/partners/gs_just_starting_step_2.png)
 
 Further details on adding a partner can be found [here](pm_adding_a_partner.md)
 

diff --git a/...bank/getting_started_storage_locations.md → ...bank/getting_started_storage_locations.md b/...bank/getting_started_storage_locations.md → ...bank/getting_started_storage_locations.md
@@ -9,15 +9,15 @@ When you are inputting donations, or purchases, you will specify the storage loc
 
 How do you enter a storage location?   If you haven't any storage locations yet, you can click on "Add a Storage Location" in the "Just Starting?" sequence at the top of your dashboard.  
 
-![navigation](images/gs_just_starting_step_1.png)
+![navigation](images/getting_started/storage_locations/gs_just_starting_step_1.png)
 
 You can also click on "Inventory", then "Storage Locations" in the left-hand menu, then "New Storage Locations"
 
-![navigation](images/gs_storage_locations_navigation.png)
+![navigation](images/getting_started/storage_locations/gs_storage_locations_navigation.png)
 
 Either of these will bring up the new storage location screen
 
-![navigation](images/new_storage_location.png)
+![navigation](images/getting_started/storage_locations/new_storage_location.png)
 
 Fill in the information:
 - Name and Address are mandatory
@@ -30,6 +30,6 @@ Click "Save"
 
 You'll see a list of your storage locations.  Click "New Storage Location" if you want to enter another locations.
 
-![navigation](images/storage_location_index.png)
+![storage location index](images/getting_started/storage_locations/storage_location_index.png)
 
 Next step:  [Entering or uploading your initial partner list](getting_started_partners.md)