starting into TODOs; style guide (mostly for own reference for now)

Gemfile.lock

@@ -798,4 +798,4 @@ DEPENDENCIES
   webmock (~> 3.24)
 
 BUNDLED WITH
-   2.5.21
+   2.5.22

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2024_08_30_015517) do
+ActiveRecord::Schema[7.1].define(version: 2024_10_02_205346) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 

docs/user_guide/bank/account_management.md

@@ -1,7 +1,5 @@
 DRAFT USER GUIDE
-# Signing out and other things for the top right menu
-
-(TODO:  Need a better title)
+# Account Management
 
 ## Logging out
 You can log out be clicking your name in the top right corner, then clicking 'Log out'.
@@ -22,6 +20,8 @@ Then 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 ]
+
 
 
 [Prior: User management](user_management.md) [Next: Asking for changes](asking_for_changes.md)

docs/user_guide/bank/community_donation_sites.md

@@ -1,6 +1,9 @@
 # Donation Sites
 
-Donation sites are places where people drop off donations. You can manage the sites' information on the "Donation Sites" page under the "Community" section. 
+Donation sites are places where people drop off donations. 
+
+## 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)
 
@@ -16,6 +19,7 @@ Note that the donation site and address fields are mandatory while the contact n
 
 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)
 
 After saving the site's details there will be a new row on the Donation Sites page.
@@ -36,6 +40,8 @@ Clicking on the "Edit" button beside a donation site in the donation site list l
 
 Use the "Deactivate" button to delete information about 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

docs/user_guide/bank/essentials_donations.md

@@ -9,7 +9,7 @@ In Human Essentials you enter in-kind donations by specifying where they came fr
 
 To view a list of all your donations, click on 'Donations', then "All Donations" in the left-hand menu,
 
-[TODO:  Insert navigational screenshot here.]
+![Navigating to Donations](images/essentials/donations/essentials_donations_1.png)
 
 This screen includes a filter so you can narrow down your search to a particular donation, and some basic information on each donation:
 - Source -- Whether this comes from a [Product Drive](product_drives.md),  Manufacturer, Donation Site, or Miscellaneous Donation
@@ -22,11 +22,10 @@ This screen includes a filter so you can narrow down your search to a particular
 - Comments
 - Actions - you can view or print donations from this screen.  Other actions are available on the view screen.
 
-[TODO:  talk about the totals]
-
 ### Filtering the donation list
 
-[TODO: Insert mini screenshot of just the filtration section here]
+
+![Donations Filter Section](images/essentials/donations/essentials_donations_2.png)
 
 When you have been using human essentials for a few months, your donation list may grow to the point that you really need to be able to narrow things down to find a particular donation.
 
@@ -44,7 +43,22 @@ Clicking "Clear filters" will blank out the filters that are drop-down selection
 To enter a new donation, click "Donations", then "New Donation" on the left hand menu, or click the +New Donation button on the Donations list.
 
 
-[TODO:  Insert navigational screenshot here.]
+![Navigation to New Donations](images/essentials/donations/essentials_donations_3.png)
+
+Here you can enter all the information for your donation:
+
+- Source
+  - What kind of donation this is.  You have a choice of product drive, donation site, manufacturer or misc. donation.  If you pick anything but misc. donation,  you will be prompted for more details.
+- Storage Location
+- Money raised in dollars (optional)
+- Comment (optional)
+- Issued On 
+  - This is the date that the donation was made.  Note that inventory changes happen as of when you enter  the information.  They are not back-dated.
+- Items in this donation
+  - If you have set up [barcodes ](inventory_barcodes.md) for the items you are receiving,  you can use your barcode reader to enter your items.  Otherwise, pick the item from "Choose an item", and enter the number of that item in "Quantity".
+  - Click "add another item" as needed to get room for more items.
+
+When you are finished entering your information, click 'Save'.  
 
 ### Information entered in Donations
 #### Source
@@ -55,8 +69,7 @@ For Product Drive, Manufacturer, or Donation Site, you will further specify the
 If  you specify Product drive,  you'll also need to specify the particular drive and participant for the donation -- but you can enter them "on the fly", here. You can view summaries for the product drives in [Product Drives](product_drives.md), and manage the contact info for a product drive participant under [Community | Product Drive Participants](community_product_drive_participants.md).
 ##### *Donation Site
 Donation Site is meant to capture the concept of any place you have a more-or-less permanent place people can drop off donations at, such as your main office, or community locations such as fire halls, etc.
-You can see the donations for each donation site and manage their contaact information under [Community|Donation Sites](community_donation_sites.md).  Unlike product drives, you can't create a new donation site 'on the fly' through the fields here.
-[TODO:  Check if there is a good reason for that,  or if we're just inconsistent.  I think a new donation site is just as likely as a new manufacturer!]
+You can see the donations for each donation site and manage their contact information under [Community|Donation Sites](community_donation_sites.md).  Unlike product drives, you can't create a new donation site 'on the fly' through the fields here.
 
 ##### *Manufacturer
 This is for the donations that come straight from the manufacturer.  You can view the total donations and a donation breakdown for each manufacturer under [Community | Manufacturers](community_manufacturers.md)
@@ -86,12 +99,38 @@ When you are done entering your items,  click "Save".  Barring any errors, this
 
 ## Viewing the details of a donation
 To view the details of a donation, click on the "View" button beside the donation on the All Donations page.
-[TODO:  Navigational screenshot]
-Here you'll see the donation, and have the opportunity to make a correction, to delete the donation, to print it.   You can also start a new distribution from this page.  [TODO:  Write up a reason we have this button here?!]
+
+![Navigation to New Donations](images/essentials/donations/essentials_donations_4.png)
+
+Here you'll see the donation, including:
+- Date 
+- Source 
+- Donation Site
+- Storage Location
+- for each Item in the donation
+  - Item name
+  - Quantity in the donation
+  - Total in-kind value for that item
+- Total quantity of items, and
+- Total in-kind value
+- Comment
+
+You can make a correction, to delete the donation, to print it.   You can also start a new distribution from this page.  (This is a convenience for banks that distribute the bulk of their donations immediately, and don't fulfill partner requests.)
+
+![Single Donation View](images/essentials/donations/essentials_donations_5.png)
+
 
 ## Editing a donation
-Donations shouldn't need to be updated very often -- you usually have all the information you need when you enter them the first time.  Differences in the physical count, or new information may occasion a need for a correction, though.  If you need to correct a donation,  you first "View" it, then "Make a Correction"
-[TODO:  Navigational screenshots]
+Donations shouldn't need to be updated very often -- you usually have all the information you need when you enter them the first time.  Differences in the physical count, or new information may occasion a need for a correction, though.  If you need to correct a donation,  you first "View" it (see above), then "Make a Correction"
+
+
+![Navigation to Edit a Donation](images/essentials/donations/essentials_donations_6.png)
+
+Here, you can change all the information on the donation, including adding and removing items.  
+
+##### Note that changes you make to the levels of items will take effect as of the date you made the changes.  They will not be back-dated to the "issued on" date
+
+##### Note also that donations do not currently work well with kits.  We have an open issue for this.
 
 ## Deleting a donation
 Hopefully you won't need to delete a donation - but it's certainly possible that you might have entered a duplicate.   Should you need to delete the donation,  "View" it from the All Donations page, then click 'Delete'.  You'll be asked to confirm your decision.  Use this with extreme caution - because you won't be able to undelete it!

docs/user_guide/bank/getting_started_choices.md

@@ -11,14 +11,12 @@ Some questions that will help you when you are setting up Human Essentials.  Thi
 - Do you (your bank) want to start out immediately with my partners making requests, or do you want to just track your distributions for awhile first?
 - Do you run on a monthly cycle, or more on an adhoc basis?
 - What information do you need from our partners (see [Partner Profile](pm_partner_profiles.md) for what you *can* collect in the system - this is somewhat configurable)?
-- Do you need to get all that information from your partners before they can enter requests? 
+  - Do you need to get all that information from your partners before they can enter requests? 
 - Do you have different groups of partners allowed to request different items? (if so, you'll want to look at [Partner Groups](pm_))
 - Who should have admin access?  (See [Access Levels](getting_started_access_levels.md))
 - Do you repackage items into 'kits'? (common for period-focused banks)
 - How do you want your partners requesting from you?  (By # of individuals for each item, by quantity of each item, or by specific child (we don't recommend that unless they really have the need.) This is covered more in ["The Request Distribution Cycle"](pm_request_distribution_cycle.md))
-- If quantity, do you want to have our partners request in # of items, or in some other units (for instance packs, for diapers )
-
-[TODO:  This is a work in progress until we have completed everything else.]
+  - If quantity, do you want to have our partners request in # of items, or in some other units (e.g. packs, for diapers )
 
 [Prior: Support](intro_ii.md) [Next: Storage Locations](getting_started_storage_locations.md)
 

docs/user_guide/bank/getting_started_donation_sites.md

@@ -1,59 +1,15 @@
 DRAFT USER GUIDE
 # Donation Sites
-[TODO:  If we have reworked the getting started to exclude donation sites,  move this all to the community section]
-
 A donation site represents a drop-off location for donations.
 The information regarding a donation site is mainly for your reference.  There are, at time of writing, no automated emails that go to the donation sites' contacts.
 Note that you can filter your donation list ( see [Donations](essentials_donations.md)) by donation site.
 
-## The donation site list
-To see a list of your donation sites, click on "Community", then "Donation Sites" in the left-hand menu.
-[TODO: Navigation screenshot]
-The donation site list lists all your active donation sites.  This list includes:
-- Donation Site name
-- Address
-- Contact Name
-- E-mail
-- Phone
-## Adding a donation site
-[TODO:  If we haven't reworked the getting started to exclude donation sites, include it here]
-
-From the donation site list (above), then click on "New Donation Site" 
-
-[TODO:  Why do we have two ways to create a donation site (probably 3, I expect there is a short cut in donations).  Put a request in the inbox to simplify this.  I'm making an 'executive decision' that we should keep the "new donation site" way for consistency]
-
-[TODO: Navigation screenshot]
-
-[TODO: New Donation Site screenshot]
-
-Then fill in the information and click "Save".
-
-(note: at time of writing, you can also create a donation site using the fields at the top of the donation sites screen, but we will be removing that as extraneous.)
-
-## Viewing a donation site
-From the donation site list (above),  click on the "view" button beside the desired donation site.  
-
-[TODO:  The header in this needs help -- inbox!]
-
-[TODO:  Screenshot]
-
-As well as the basic information for the donation site,  the donation site view lists every donation that is associated with that donation site, including:
-- Storage location
-- Quantity of items
-- Variety of items (i.e. how many different items were donated)
-- and a link to the donation
-
-## Editing a donation site
-From the donation site list (above), you can change the basic information for a donation site by clicking "Edit" beside that donation site.
-
-[TODO: Navigational screenshot]
-
-[TODO: Edit screenshot]
-Make the changes to the displayed information (Name, Address, Contact Name, Email, and Phone), and click "Save".
-
-## Deactivating a donation site
-When a donation site is no longer in service, you can deactivate it from the donation site list by clicking "Deactivate" beside it, and confirming your choice.
+## Adding a single donation site
+If you are following along in the "getting started", you'll have reached stage 3 "Donation Sites".  You can add a single donation site by clicking on "Add a Donation Site".
+![Navigating to add a donation site from getting started](images/getting_started/donation_sites/getting_started_donation_sites_1.png)
+This will take you to the new donation site screen, where you can provide the basic information for your side.  Click save when done:
+![New donation site](images/getting_started/donation_sites/getting_started_donation_sites_2.png)
 
-##### (NB) at time of writing there is no way for you to undo this.
+To add more donation sites, or if you are in a different place in the process, see the full entry on [Donation Sites](community_donation_sites.md).
 
 [Prior: Partners](getting_started_partners.md)[Next: Inventory](getting_started_inventory.md)

docs/user_guide/bank/getting_started_storage_locations.md

@@ -22,9 +22,7 @@ Either of these will bring up the new storage location screen
 Fill in the information:
 - Name and Address are mandatory
 - Square Footage and Warehouse Type are used for the Annual Survey (our collection of information corresponding to the NDBN Annual Survey)
-- Set Time Zone to the local time zone for the storage location.  This impacts the Pickup & Deliveries calendar but not much else.  
-
-[TODO:  Understand *How* timezone affects the P&D calendar]
+- Set Time Zone to the local time zone for the storage location.
 
 Click "Save"
 

docs/user_guide/bank/pm_request_distribution_cycle.md

@@ -27,7 +27,8 @@ So,  how does this work?
 
 9/  You can mark the distribution as complete.
 
-Please note that you can edit distributions (e.g. if you have more product come in before pickup).  The partner does not get a new email if you do that.[TODO: Confirm]
+Please note that you can edit distributions (e.g. if you have more product come in before pickup).  The partner does not get a new email if you do that.
+[TODO: Confirm]
 
 
 [Prior: Pick ups and deliveries](essentials_pick_ups.md) [Next: Partner statuses](pm_partner_statuses.md)

docs/user_guide/bank/readme.md

@@ -7,7 +7,7 @@ This user guide is meant for users of the human essentials app at essentials ban
    2. [Support](intro_ii.md) 
 2. Getting started
    1. [Some choices you'll want to think about at the start. ](getting_started_choices.md)
-   3. [Storage Locations](getting_started_storage_locations.md)
+   2. [Storage Locations](getting_started_storage_locations.md)
    3. [Partner Agencies](getting_started_partners.md)
    4. [Donation sites](getting_started_donation_sites.md)
    5. [Inventory](getting_started_inventory.md)

docs/user_guide/style_guide.md

@@ -0,0 +1,30 @@
+# Style Guide
+This style guide is for the Human Essentials Bank user guide.  
+
+Its purpose is to set the standard ways of dealing with matters of style, such as hypenation, capitalization, and the like.
+
+We want to do a final pass to make everything consistent with the style guide before officially launching the guide.
+
+
+## Capitalization
+### Headings
+The first letter of a heading is capitalized.  After that,use lower case except for nouns that are always capitalized (see below)
+### Objects in the app
+Match the text to what is in the application.  For instance, if a button says "Manage Product drives".  That being said,  if there is something in the app that is inconsistent,  let's get that fixed.
+### Always capitalize
+Essentially, if it has a view in Human Essentials,  capitalize it
+- Bank
+- Partner
+- Account
+- Donation
+- Purchase
+- Product Drive
+- Product Drive Participant
+- Vendor
+- Purchase
+- Request
+- Inventory
+- Audit
+## Hyphenation
+left-hand menu
+in-kind value