From 78ea112ae5f177262c3dd3a9ee3fcc942094d95b Mon Sep 17 00:00:00 2001 From: Brock Wilcox Date: Sat, 5 Sep 2026 17:59:21 -0400 Subject: [PATCH] User guide: fix typos, broken links and stale labels - Index: repair six broken links (editing/reactivating partners, distributions by county, donation sites, inventory adjustments, the two mailer pages), fix numbering, add the reminder emails page. - Rename the two mailer preview files with odd names (a comma instead of a dot, and a capital P). - Fix bare or wrong links on the Donations, Purchases, Storage Locations, Kits, Partner Groups, Partner Statuses, Request Cycle and Barcodes pages, and point anchors at the right sections. - Fix spelling and punctuation (dashbboard, Pequests, alloocation, organizaation, cliock, Gorm, Drivess, Organisation, a dropped 'T', duplicated half-sentences) and admonition tags (WARN/INFO/Note). - Match button and status names to the app (New Partner Agency, New Announcement, Edit Partner Profile, Awaiting review, Log Out, Donations - Manufacturer, Partner approved!). Co-Authored-By: Claude Fable 5.1 Claude-Session: https://claude.ai/code/session_01LMAt57FU2qBq45yR7YCsEZ --- docs/user_guide/bank/account_management.md | 6 ++-- .../bank/community_donation_sites.md | 2 +- .../community_product_drive_participants.md | 2 +- ...view.md => distribution_mailer_preview.md} | 0 docs/user_guide/bank/essentials_dashboard.md | 2 +- .../bank/essentials_distributions.md | 4 +-- docs/user_guide/bank/essentials_donations.md | 8 ++--- docs/user_guide/bank/essentials_pick_ups.md | 2 +- docs/user_guide/bank/essentials_purchases.md | 6 ++-- .../bank/getting_started_choices.md | 2 +- .../bank/getting_started_partners.md | 2 +- .../bank/getting_started_user_management.md | 2 +- ...ntials_distributions_print_navigation.png} | Bin docs/user_guide/bank/inventory_adjustments.md | 2 +- docs/user_guide/bank/inventory_barcodes.md | 2 +- docs/user_guide/bank/inventory_items.md | 6 ++-- docs/user_guide/bank/inventory_kits.md | 32 ++++-------------- .../bank/inventory_storage_locations.md | 8 ++--- docs/user_guide/bank/pm_announcements.md | 2 +- .../user_guide/bank/pm_approving_a_partner.md | 6 ++-- docs/user_guide/bank/pm_editing_a_partner.md | 2 +- docs/user_guide/bank/pm_inviting_a_partner.md | 4 +-- docs/user_guide/bank/pm_partner_groups.md | 9 +++-- docs/user_guide/bank/pm_partner_profiles.md | 6 ++-- docs/user_guide/bank/pm_partner_statuses.md | 4 +-- docs/user_guide/bank/pm_partner_user_admin.md | 2 +- .../bank/pm_request_distribution_cycle.md | 4 +-- .../bank/pm_requesting_recertification.md | 8 ++--- docs/user_guide/bank/readme.md | 29 ++++++++-------- .../bank/reports_manufacturers_donations.md | 2 +- ...> requests_confirmation_mailer_preview.md} | 0 31 files changed, 72 insertions(+), 94 deletions(-) rename docs/user_guide/bank/{distribution_mailer_Preview.md => distribution_mailer_preview.md} (100%) rename docs/user_guide/bank/images/essentials/distributions/{essentials_distribution_print_navigation.png => essentials_distributions_print_navigation.png} (100%) rename docs/user_guide/bank/{requests_confirmation_mailer_preview,md => requests_confirmation_mailer_preview.md} (100%) diff --git a/docs/user_guide/bank/account_management.md b/docs/user_guide/bank/account_management.md index 03f52bd46a..e00398b51f 100644 --- a/docs/user_guide/bank/account_management.md +++ b/docs/user_guide/bank/account_management.md @@ -1,7 +1,7 @@ # Account Management ## Logging out -You can log out be clicking your name in the top right corner, then clicking 'Log out'. +You can log out by clicking your name in the top right corner, then clicking "Log Out". ![Navigating to log out](images/account_management/account_management_logout.png) @@ -13,15 +13,13 @@ Provide your updated information, including your current password, then click s 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. ![Account settings screen](images/account_management/account_management_account_settings.png) -hen click save. - ## My organization 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. +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 organization (bank or Partner) that you want to switch to. diff --git a/docs/user_guide/bank/community_donation_sites.md b/docs/user_guide/bank/community_donation_sites.md index ea97c48f36..8c5858c2ed 100644 --- a/docs/user_guide/bank/community_donation_sites.md +++ b/docs/user_guide/bank/community_donation_sites.md @@ -7,7 +7,7 @@ You can manage the sites' information on the "Donation Sites" page under the "Co ![Donation Sites](images/community/donation_sites/donation_sites.png) -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 Donation Site name, address, contact name, email and phone number. ### Adding a Donation Site diff --git a/docs/user_guide/bank/community_product_drive_participants.md b/docs/user_guide/bank/community_product_drive_participants.md index db4fd60bc3..9d8a25f3bc 100644 --- a/docs/user_guide/bank/community_product_drive_participants.md +++ b/docs/user_guide/bank/community_product_drive_participants.md @@ -38,4 +38,4 @@ Currently we are not providing all the participants' details in the export. ![Export Drive Participants](images/community/product_drive_participants/export_participants.jpg) -[Prior: Product Drivess](community_product_drives.md)[Next: Donation Sites](community_donation_sites.md) \ No newline at end of file +[Prior: Product Drives](community_product_drives.md)[Next: Donation Sites](community_donation_sites.md) \ No newline at end of file diff --git a/docs/user_guide/bank/distribution_mailer_Preview.md b/docs/user_guide/bank/distribution_mailer_preview.md similarity index 100% rename from docs/user_guide/bank/distribution_mailer_Preview.md rename to docs/user_guide/bank/distribution_mailer_preview.md diff --git a/docs/user_guide/bank/essentials_dashboard.md b/docs/user_guide/bank/essentials_dashboard.md index 218a1a4650..6fff4b8c14 100644 --- a/docs/user_guide/bank/essentials_dashboard.md +++ b/docs/user_guide/bank/essentials_dashboard.md @@ -24,4 +24,4 @@ This lists Items whose *bank-wide* inventory has fallen below the recommended or 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. -[Next: Entering or uploading your initial partner list](getting_started_partners.md) [Next: Donations](essentials_donations.md) \ No newline at end of file +[Prior: Entering or uploading your initial partner list](getting_started_partners.md) [Next: Donations](essentials_donations.md) \ No newline at end of file diff --git a/docs/user_guide/bank/essentials_distributions.md b/docs/user_guide/bank/essentials_distributions.md index e2eb7353a0..e98c1aa028 100644 --- a/docs/user_guide/bank/essentials_distributions.md +++ b/docs/user_guide/bank/essentials_distributions.md @@ -21,7 +21,7 @@ If you pick several things, you will get only the Distributions that match all Except for date range, all the filters are specified by picking from a drop-down list as follows: - Item: all of your bank's Items. This will filter to only the distributions that contain that Item. -- Item Category: Item Categories (as specified in [Items & Inventory -- Item Categories](inventory_items.md)). This will filter the list to the distributions that contain items that are in the chosen item category. +- Item Category: Item Categories (as specified in [Items & Inventory -- Item Categories](inventory_items.md#item-categories)). This will filter the list to the distributions that contain items that are in the chosen item category. - Partner: This will filter the lists to just the distributions to the chosen partner. - Source Inventory: This will limit the list to the distributions from the chosen storage location. - Status: Distributions can be Scheduled or Complete. This will limit the list to those with the given status. @@ -102,7 +102,7 @@ Please note that your logo (also configurable on the [Organization](getting_star ## Reclaiming a Distribution What do you do if, for some reason, the Distribution that was entered was not picked up? You can reclaim it, adding the items back into your inventory. -To do this, click "Reclaim" beside the Distribution in question, and cliock "Ok" in the confirmation screen that appears. +To do this, click "Reclaim" beside the Distribution in question, and click "OK" in the confirmation screen that appears. [!WARN] You can not reverse a reclaim. If you reclaim by accident, you will have to re-enter the Distribution. If that happens, you should be able to grab the Item quantities from the [History Report](reports_history.md), but we don't retain the rest of the information. diff --git a/docs/user_guide/bank/essentials_donations.md b/docs/user_guide/bank/essentials_donations.md index 9ae61273a6..4576edc660 100644 --- a/docs/user_guide/bank/essentials_donations.md +++ b/docs/user_guide/bank/essentials_donations.md @@ -10,7 +10,7 @@ To view a list of all your Donations, click on 'Donations', then "All Donations" ![Navigating to Donations](images/essentials/donations/essentials_donations_1.png) This screen includes a filter so you can narrow down your search for a Donation, and some basic information on each Donation: -- Source -- Whether this comes from a [Product Drive](product_drives.md), [Manufacturer](community_manufacturers.md), [Donation Site](community_donation_sites.md), or Miscellaneous Donation +- Source -- Whether this comes from a [Product Drive](community_product_drives.md), [Manufacturer](community_manufacturers.md), [Donation Site](community_donation_sites.md), or Miscellaneous Donation - Date -- The date of the Donation - Details -- this depends on the source -- it is the name of the Product drive, or Manufacturer, or Donation site - Storage location -- where the goods from this Donation are stored. @@ -64,7 +64,7 @@ Here you specify what kind of source the Donation originated from. For Product Drive, Manufacturer, or Donation Site, you will further specify the specific source. ##### *Product Drive -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). +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](community_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 contact information under [Community -- Donation Sites](community_donation_sites.md). Like Product Drives, you can create a new Donation Site 'on the fly' through the fields here too. @@ -74,7 +74,7 @@ This is for the donations that come straight from a Manufacturer. You can view Misc. Donation is a catch-all for any Donation without an identified source. #### Storage Location -Pick the Storage Location the Donation is going to. If it will be split among multiple locations, you can either enter separate Donations, or enter the Donation using one location, then use the [Inventory -- Transfers] function to move the appropriate inventory to other locations. +Pick the Storage Location the Donation is going to. If it will be split among multiple locations, you can either enter separate Donations, or enter the Donation using one location, then use the [Inventory -- Transfers](inventory_transfers.md) function to move the appropriate inventory to other locations. #### Money raised in dollars This number is used in the Annual Survey, and the Donations - Summary report as well as being shown in the main Donations page. @@ -85,7 +85,7 @@ This is the date we use for any and all date filtering that you might do on Dona #### Items in this donation There are a couple of ways to get Items into the donation quickly: -(1) You can "bloop" a barcode -- that requires some initial setup, as detailed in [Inventory -- Barcodes], or +(1) You can "bloop" a barcode -- that requires some initial setup, as detailed in [Inventory -- Barcodes](inventory_barcodes.md), or (2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item. In either case, you can click "Add Another Item" (3) to open up another item for entry, or "Remove" (4) if you've added too many! diff --git a/docs/user_guide/bank/essentials_pick_ups.md b/docs/user_guide/bank/essentials_pick_ups.md index 5d45efee5b..dc1ddec947 100644 --- a/docs/user_guide/bank/essentials_pick_ups.md +++ b/docs/user_guide/bank/essentials_pick_ups.md @@ -13,7 +13,7 @@ The Distribution Schedule page shows details including the Partner,the time of D 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 Storage Location, agency representative, delivery method, shipping cost, comments, and state. This also shows a list of items included in the Distribution. +Click "View" for details on the Distribution's source Storage Location, agency representative, delivery method, shipping cost, comments, and status. This also shows a list of items included in the Distribution. ![Distribution from Source Inventory to Partner](images/essentials/pick_ups/distribution_from_source_to_partner.jpg) diff --git a/docs/user_guide/bank/essentials_purchases.md b/docs/user_guide/bank/essentials_purchases.md index a16bc14d79..486927c625 100644 --- a/docs/user_guide/bank/essentials_purchases.md +++ b/docs/user_guide/bank/essentials_purchases.md @@ -32,7 +32,7 @@ To enter a new Purchase, you can either click "Purchases -- New Purchase" on th ![Navigation to new Purchase](images/essentials/purchases/essentials_purchases_3.png) -![new Purchase screen](images/essentials/purchases/essential_purchases_4.png) +![new Purchase screen](images/essentials/purchases/essentials_purchases_4.png) Enter the following information (starred items are mandatory): ### Vendor * Select the Vendor from a drop-down list of all your vendors. If you choose "Not Listed", you can enter a new vendor on the fly. The Business Name is mandatory. @@ -52,7 +52,7 @@ This is optional. This should be the date the Purchase was made - it is defaulted to today's date. This is used for filtering, but also for what year the Purchase is included in for the annual survey. ### Items in this Purchase There are a couple of ways to get items into the Purchase quickly: -(1)You can "bloop" a barcode in to get your items into the system -- that requires some initial setup, as detailed in [Inventory -- Barcodes] or (2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item. +(1)You can "bloop" a barcode in to get your items into the system -- that requires some initial setup, as detailed in [Inventory -- Barcodes](inventory_barcodes.md) or (2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item. In either case, you can click "Add Another Item" (3) to open up another item for entry, or "Remove" (4) if you've added too many! The quantity here is meant to be individual items (e.g. diapers), rather than packs. The reason behind this is that, ultimately, your reporting will be based on the number of individual items, and package size is inconsistent across brands. @@ -62,7 +62,7 @@ When you are done entering your Items, click "Save". Barring any errors, this ## Viewing a Purchase To view Purchase details, click the "View" button beside the Purchase on the All Purchases list. -[ Navigational screenshot for view Purchase](images/essentials/purchases/essential_purchases_4.png) +![Navigational screenshot for view Purchase](images/essentials/purchases/essentials_purchases_4.png) This brings up a page with the Purchase's details, including all the information you entered and the entry date. From here you can make a correction to the Purchase or delete it. diff --git a/docs/user_guide/bank/getting_started_choices.md b/docs/user_guide/bank/getting_started_choices.md index f855d38fb4..a56fdb7895 100644 --- a/docs/user_guide/bank/getting_started_choices.md +++ b/docs/user_guide/bank/getting_started_choices.md @@ -8,7 +8,7 @@ Here are some questions that will help you when you are setting up Human Essenti - Do you run on a monthly cycle, or on more of 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 have different groups of partners allowed to request different items? (if so, you'll want to look at [Partner Groups](pm_)) +- Do you have different groups of partners allowed to request different items? (if so, you'll want to look at [Partner Groups](pm_partner_groups.md)) - 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)) diff --git a/docs/user_guide/bank/getting_started_partners.md b/docs/user_guide/bank/getting_started_partners.md index 484f1944a5..9985bc7953 100644 --- a/docs/user_guide/bank/getting_started_partners.md +++ b/docs/user_guide/bank/getting_started_partners.md @@ -25,7 +25,7 @@ For your first partner, you can Click on the "Add a single partner" link in your ![navigation](images/getting_started/partners/gs_add_partner_1.png) -For any subsequent Partners, please click on "Partner Agencies", then "All Partners", then "Add a Partner") +For any subsequent Partners, please click on "Partner Agencies", then "All Partners", then "New Partner Agency". ![add a partner navigation](images/partners/partners_add_navigation.png) diff --git a/docs/user_guide/bank/getting_started_user_management.md b/docs/user_guide/bank/getting_started_user_management.md index 7f893374ce..d7c5e01cb4 100644 --- a/docs/user_guide/bank/getting_started_user_management.md +++ b/docs/user_guide/bank/getting_started_user_management.md @@ -6,7 +6,7 @@ Note that only people with admin status can administer Users, and that Partners To manage the rights for your Essentials Bank's Users: -Click on the My Organisation view, then scroll down to the bottom. There is a User administration section there. +Click on "My Organization" in the left-hand menu, then scroll down to the bottom. There is a "Users" section there. You can also manage the Users in your Partners, see [Administering Partner Users](pm_partner_user_admin.md). diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distribution_print_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_print_navigation.png similarity index 100% rename from docs/user_guide/bank/images/essentials/distributions/essentials_distribution_print_navigation.png rename to docs/user_guide/bank/images/essentials/distributions/essentials_distributions_print_navigation.png diff --git a/docs/user_guide/bank/inventory_adjustments.md b/docs/user_guide/bank/inventory_adjustments.md index 9d23a32b0e..401cdd6fe1 100644 --- a/docs/user_guide/bank/inventory_adjustments.md +++ b/docs/user_guide/bank/inventory_adjustments.md @@ -24,7 +24,7 @@ Choose the Storage Location, add any notes you have in the comments section, an Click save to finish entering the adjustment. This will change the inventory levels on those items. -In this sample there are both negative adjustments (showing in red, with "Removed") and positive adjustments (showing in green, with "Added) +In this sample there are both negative adjustments (showing in red, with "Removed") and positive adjustments (showing in green, with "Added") ![Result of entering adjustment](images/inventory/inventory_adjustments_result.png) diff --git a/docs/user_guide/bank/inventory_barcodes.md b/docs/user_guide/bank/inventory_barcodes.md index bb5edfe287..10cb9d911e 100644 --- a/docs/user_guide/bank/inventory_barcodes.md +++ b/docs/user_guide/bank/inventory_barcodes.md @@ -43,4 +43,4 @@ To export a list of the Barcodes, just click "Export Barcodes" on the Barcodes p ![Export Barcodes sample](images/inventory/inventory_barcodes_export.png) -[Prior: Audits](inventory_audits.md) [Next: Adjustments](inventory_adjustments.md) \ No newline at end of file +[Prior: Kits](inventory_kits.md) [Next: Adjustments](inventory_adjustments.md) \ No newline at end of file diff --git a/docs/user_guide/bank/inventory_items.md b/docs/user_guide/bank/inventory_items.md index 3701c68d14..df251f9d3f 100644 --- a/docs/user_guide/bank/inventory_items.md +++ b/docs/user_guide/bank/inventory_items.md @@ -100,9 +100,9 @@ Clicking "Edit" beside an Item on the Item list lets you edit the Item definitio To add a new Item, click the "+ New Item" button on this page. It will bring up the same page as "Editing an Item", above (only, of course, with none of the fields completed). #### Deleting or Deactivating an Item -The button "delete" will appear beside an Item if there hasn't been any activity on it at all. (A) Deleting an Item is permanent +The button "Delete" will appear beside an Item if there hasn't been any activity on it at all (A). Deleting an Item is permanent. -The button "deactivate" will appear if there has been activity. But it will be greyed out unless your bank-wide level of inventory on that Item is 0. (B)) +The button "Deactivate" will appear if there has been activity (B). But it will be greyed out unless your bank-wide level of inventory on that Item is 0. Deactivating an Item removes it whenever you are entering a new distribution/donation/purchase/transfer/audit, and removes it from the partner's new requests. You can still see deactivated items in most reports, and can include them in your filtered lists. @@ -110,7 +110,7 @@ You can still see deactivated items in most reports, and can include them in you #### Reactivating an Item To reactivate an Item, you'll need to -(1) click "Also include inactive Items" +(1) click "Also include inactive items" (2) click "Filter", then (3) click "Restore" beside the Item you wish to reactivate. diff --git a/docs/user_guide/bank/inventory_kits.md b/docs/user_guide/bank/inventory_kits.md index 365126aa23..77c1624b72 100644 --- a/docs/user_guide/bank/inventory_kits.md +++ b/docs/user_guide/bank/inventory_kits.md @@ -18,7 +18,7 @@ Then you distribute those period Kits. ## Creating a Kit -[!WARN] You can't edit a Kit -- once you've defined it, it's set in stone. So do be careful! +[!WARNING] You can't edit a Kit -- once you've defined it, it's set in stone. So do be careful! To create a Kit, click on "Inventory", then "Kits" in your left hand menu. This brings up a page that shows all your current Kits. Then click the "+New Kit" button on the right hand side of the page. @@ -29,14 +29,14 @@ This brings up the "New Kit" form, which has the following info: ![New Kit](images/inventory/inventory_kits_new.png) - Name: This is the Item name for the Kit -- what it will appear as in the drop-down lists and in any reports - Item is Visible to Partners? Check this if you allow Partners to order the Kit. -[!INFO] If you need to control which Partners can request a Kit, you'll need to put it in a category once you've defined it, through the Item page, after creation, and use Partner Groups to control which Partners can request the Item. +[!NOTE] If you need to control which Partners can request a Kit, you'll need to put it in a category once you've defined it, through the Item page, after creation, and use Partner Groups to control which Partners can request the Item. [(see Editing an Item)](inventory_items.md#editing-an-item), [Item Categories](inventory_items.md#item-categories) and [Partner Groups](pm_partner_groups.md) - Value for Kit: This is the Fair Market Value for the Kit. We don't sum up the Items within the Kits for FMV calculations. - Items in this Kit: You can enter multiple Items, adding each Item with the following - Barcode Entry -- if you have already entered [Barcode Items](inventory_barcodes.md), you can just "boop" the Item into the Kit. OR - - Choose an Item from the list of all [Items](inventory_Items.md) you have, and add the quantity of the Item that will be in the Kit. + - Choose an Item from the list of all [Items](inventory_items.md) you have, and add the quantity of the Item that will be in the Kit. To add the rest of your Items, click "+Add Another Item." If you need to remove an Item, click "Remove" under it. @@ -50,16 +50,16 @@ Once you have created your Kit, you can allocate it. This represents assembli From the Kits page (Inventory -- Kits), click "Modify Allocation" on your Kit -![Navigation to Kit alloocation](images/inventory/inventory_kits_modify_allocation_navigation.png) +![Navigation to Kit allocation](images/inventory/inventory_kits_modify_allocation_navigation.png) This takes you to the Kit Allocation page This lists your current on-hand quantity for each storage location you have Kits in, and lets you change the allocation. -Pick the Storage Location (A) and the amount you want to increase the Kits by (B). When you put a number in the "Change Kit quantity ", you'll see what effect the allocation will have on your inventory. +Pick the Storage Location (A) and the amount you want to increase the Kits by (B). When you put a number in "Change Kit quantity by", you'll see what effect the allocation will have on your inventory. ![Kit Allocation](images/inventory/inventory_kits_allocation.png) -[!NOTE] you can also 'deallocate' Kits if need be, by putting a negative number in the "Change Kit quantity by" field. When you deallocation Kits, the contents will be returned to the appropriate Items' inventory. +[!NOTE] you can also 'deallocate' Kits if need be, by putting a negative number in the "Change Kit quantity by" field. When you deallocate Kits, the contents will be returned to the appropriate Items' inventory. Then click "Save". The system will check if there are enough of each component Item in the storage location. If there isn't, it will give you an error. If there is, it will adjust the inventory appropriately, and return to this screen, which will reflect the new on-hand quantity. @@ -82,23 +82,3 @@ Then click "Reactivate" beside the Kit you wish to reactivate and click "OK" to [Prior: Audits](inventory_audits.md) [Next: Barcodes](inventory_barcodes.md) - - - - - - - - - - - - - - - - - - - - diff --git a/docs/user_guide/bank/inventory_storage_locations.md b/docs/user_guide/bank/inventory_storage_locations.md index 75378c9356..e8fbde4362 100644 --- a/docs/user_guide/bank/inventory_storage_locations.md +++ b/docs/user_guide/bank/inventory_storage_locations.md @@ -32,19 +32,19 @@ That shows the inventory at the beginning of the day. ![Storage Location - Inventory tab](images/inventory/inventory_storage_location_view_inventory.png) ### Inventory Coming In -This shows the sum of all the inventory coming in ([Purchases](essentials_purchases.md), [Donations](essentials_donations.md), [Adjustments](inventory_adjustments.md), [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given Storage Location for all time +This shows the sum of all the inventory coming in ([Purchases](essentials_purchases.md), [Donations](essentials_donations.md), [Adjustments](inventory_adjustments.md), [Transfers](inventory_transfers.md), and [Kit](inventory_kits.md) allocations and de-allocations that add inventory) for the given Storage Location for all time ![Inventory coming in](images/inventory/inventory_storage_locations_coming_in.png) ### Inventory Going Out -This shows the sum of all the inventory going out ([Distributions](essentials_purchases.md), [Adjustments](inventory_adjustments.md), and [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given Storage Location for all time +This shows the sum of all the inventory going out ([Distributions](essentials_distributions.md), [Adjustments](inventory_adjustments.md), [Transfers](inventory_transfers.md), and [Kit](inventory_kits.md) allocations and de-allocations that remove inventory) for the given Storage Location for all time ![Inventory going out](images/inventory/inventory_storage_locations_going_out.png) ## Editing a Storage Location You can edit your Storage Location (though it seems a very rare event), by clicking "Edit" beside the Storage Location in the Storage Location Summary Page. -The same fields are as available as for [New Storage Locations](inventory_storage_locations.md). Make your updates and click save. +The same fields are available as for [new Storage Locations](#adding-a-storage-location). Make your updates and click save. ## Deactivating a Storage Location You can only deactivate a Storage Location if the inventory for all its items is 0. @@ -52,7 +52,7 @@ To deactivate the Storage Location, click "Deactivate" beside it on the Storage ## Reactivating a Storage Location If you need to reactivate a Storage Location that was deactivated, go to the Storage Locations summary screen (Inventory -- Storage Locations), then click "include inactive Storage Locations", then Filter. -This will include inactive Storage Locations in the list. Find the Storage Location you want to use again and clic "Reactivate" beside it. +This will include inactive Storage Locations in the list. Find the Storage Location you want to use again and click "Reactivate" beside it. ![Storage Location reactivation](images/inventory/inventory_storage_location_reactivation.png) diff --git a/docs/user_guide/bank/pm_announcements.md b/docs/user_guide/bank/pm_announcements.md index d781af1f1c..f5635c98a5 100644 --- a/docs/user_guide/bank/pm_announcements.md +++ b/docs/user_guide/bank/pm_announcements.md @@ -11,7 +11,7 @@ Click on "Partner Agencies" in the left hand menu, then "Partner Announcement". ![all announcements screen](images/partners/partners_announcements_1.png) -Click the "New Announcements" button to bring up a form for a new Announcement +Click the "New Announcement" button to bring up a form for a new Announcement ![new announcement screen](images/partners/partners_announcements_2.png) diff --git a/docs/user_guide/bank/pm_approving_a_partner.md b/docs/user_guide/bank/pm_approving_a_partner.md index b254908081..2d4103047e 100644 --- a/docs/user_guide/bank/pm_approving_a_partner.md +++ b/docs/user_guide/bank/pm_approving_a_partner.md @@ -27,10 +27,10 @@ See [Partner profiles](pm_partner_profiles.md#viewing-a-partner-profile) for det Once you have reviewed the Partner's info, and want to approve them to make requests, click the "Approve Partner " button. -![](images/partners/partners_approving_1.png) +![Approve Partner button](images/partners/partners_approving_1.png) -You should see a "Partner Approved!" message, and the status of the Partner will show as "Approved" +You should see a "Partner approved!" message, and the status of the Partner will show as "Approved" -![](images/partners/partners_approving_2.png) +![Partner approved message](images/partners/partners_approving_2.png) [Prior - Partner Profiles](pm_partner_profiles.md) [Next - Requesting Recertification](pm_requesting_recertification.md) diff --git a/docs/user_guide/bank/pm_editing_a_partner.md b/docs/user_guide/bank/pm_editing_a_partner.md index 23af6fee2f..2c33cea8e5 100644 --- a/docs/user_guide/bank/pm_editing_a_partner.md +++ b/docs/user_guide/bank/pm_editing_a_partner.md @@ -8,7 +8,7 @@ That will bring up this screen. Click "Edit details" to bring up the Partner ed ![top of View Partner screen](images/partners/partners_edit_navigation.png) -This is the same selection of information you provided when you initially added the partner. +This is the same selection of information you provided when you initially added the partner (see [Adding a Partner](pm_adding_a_partner.md) for what each field does). ![edit page for basic Partner information](images/partners/partners_edit.png) diff --git a/docs/user_guide/bank/pm_inviting_a_partner.md b/docs/user_guide/bank/pm_inviting_a_partner.md index bc7e73654d..0b3658b869 100644 --- a/docs/user_guide/bank/pm_inviting_a_partner.md +++ b/docs/user_guide/bank/pm_inviting_a_partner.md @@ -3,7 +3,7 @@ Before a Partner can make Requests, they have to be invited and approved. When they are invited, they will receive an email with a link so that they can set up their password. -These links expire in a couple of weeks, but if they don't respond in time, +These links expire, so if they don't respond in time, you can direct them to use the "Forgot your password?" function on the sign-in page (https://humanessentials.app/signin) to get a new link to set their password. @@ -16,7 +16,7 @@ The first, default, option is: 2/ They click on the link and set up their password. -3/ They then sign in and go into their "My Organization", update whatever profile information you need (se [profile](pm_partner_profiles.md). +3/ They then sign in and click "Edit My Profile", and update whatever profile information you need (see [profile](pm_partner_profiles.md)). 4/ They submit it for your approval diff --git a/docs/user_guide/bank/pm_partner_groups.md b/docs/user_guide/bank/pm_partner_groups.md index 68d6b5bc78..ac06bdfe8a 100644 --- a/docs/user_guide/bank/pm_partner_groups.md +++ b/docs/user_guide/bank/pm_partner_groups.md @@ -4,7 +4,7 @@ You may have reasons that some partners are treated differently than others. Re - Some banks have 'tiers' of partners, where some partners have different rules about what and when they can request. - Some banks have grants that are tied to specific geographic areas, and set up specific Items for those grants (that only Partners in those geographic areas can request) -Partner Groups allow you to manage that. They allow you to set the item categories (see [Item Categories](inventory_items.md)) that a Partner Group can request +Partner Groups allow you to manage that. They allow you to set the item categories (see [Item Categories](inventory_items.md#item-categories)) that a Partner Group can request If you are going to use Partner Groups, you should 1/ Set up your Item Categories @@ -17,15 +17,14 @@ In the left-hand menu, click on "Partner Agencies", then "All Partners". The P Then click on "New Partner Group" ![Navigation for adding a Partner Group](images/partners/partners_groups_1.png) This will bring up a form like this (the categories will be different): -![New partner Group Gorm](images/partners/partners_groups_2.png) +![New Partner Group form](images/partners/partners_groups_2.png) ## Fields in the partner group form ### Name This is the name your bank will use to refer to the Partner Group. It is not visible to the partners, and is not used in any reports. It must be unique among your Partner Groups. ### Which Item Categories Can They Request? -This lists the item categories you entered (in (see [Item Categories](inventory_items.md))) +This lists the item categories you entered (see [Item Categories](inventory_items.md#item-categories)) -The Partners who are in this Partner Group will only be able to request the items in the categories you check here. Note that they will not be able -they will not be able to request any Items that are not in a category +The Partners who are in this Partner Group will only be able to request the items in the categories you check here. Note that they will not be able to request any Items that are not in a category. For clarity - if you do not choose any categories, they will not be able to choose any items, so if you are using Partner Groups, you have to use Item Categories. diff --git a/docs/user_guide/bank/pm_partner_profiles.md b/docs/user_guide/bank/pm_partner_profiles.md index a45ba45baa..43946d0a83 100644 --- a/docs/user_guide/bank/pm_partner_profiles.md +++ b/docs/user_guide/bank/pm_partner_profiles.md @@ -6,7 +6,7 @@ There is a *lot* of information in the profiles, and the information that is nee ## How does a Partner fill in and submit their profile In the Partner's view of the system, they can click on "Edit My Profile" to fill in all the information you want. -Once they have saved this, they will also see a "Submit for Approval" button. Clicking that changes their status to "Waiting for Approval", and makes them appear in your [dashboard](essentials_dashboard.md) list of partners waiting for approval, as well as making a "Review Partner's application" button appear beside them in your view of all the Partners. +Once they have saved this, they will also see a "Submit for Approval" button. Clicking that changes their status to "Awaiting review", and makes them appear in your [dashboard](essentials_dashboard.md) list of partners waiting for approval, as well as making a "Review Applicant's Profile" button appear beside them in your view of all the Partners. # Viewing a Partner Profile The Partner's profile is viewable by clicking Partner Agencies in the left hand menu, then All Partners, then the name of the Partner. Scroll down to "Partner Profile" @@ -17,7 +17,7 @@ The Partner's profile is viewable by clicking Partner Agencies in the left hand More information about the partner profile can be found under "Editing a Partner's Profile", below. # Editing a Partner's Profile -You can edit a Partner Profile clicking Partner Agencies in the left hand menu, then All Partners, then "view" beside the partner in question. Scroll down to "Partner Profile", then click "Edit partner profile" +You can edit a Partner Profile clicking Partner Agencies in the left hand menu, then All Partners, then "view" beside the partner in question. Scroll down to "Partner Profile", then click "Edit Partner Profile" ![Partner Profile Edit Navigation 1](images/partners/partners_profile_edit_navigation_1.png) @@ -189,7 +189,7 @@ Contact information for your bank's primary contact This is for your information only. It is not used for any emails. ### Pick Up Person -![screenshot of expanded pick up person section] +![screenshot of expanded pick up person section](images/partners/partners_profile_edit_pick_up.png) The Pick up person (as well as the person who made the Request) will receive an email when a Distribution is scheduled, if the Distribution type is "Pick up" - Pick Up Person Name - Pick Up Person's Phone # diff --git a/docs/user_guide/bank/pm_partner_statuses.md b/docs/user_guide/bank/pm_partner_statuses.md index a4156ce6ad..d5fb496e9e 100644 --- a/docs/user_guide/bank/pm_partner_statuses.md +++ b/docs/user_guide/bank/pm_partner_statuses.md @@ -8,7 +8,7 @@ There are three Partner statuses, which have different impacts on how you intera ## Uninvited You can add Partners without inviting them to the system. In this case, you can make Distributions to them in the system. The Partners can not sign in to the system, and so will not directly provide the information in the Partner Profile. This is the status of freshly imported Partners. -The Partners will still get emails regarding deadlines and Distributions (assuming you have set them up to do so through your bank's [customization](getting_started_customization.md#reminder-emails-optional) and any [Partner Groups](pm_partner_groups.md#do-you-want-to-send-deadline-reminders-to-them-every-month) they belong to. +The Partners will still get emails regarding deadlines and Distributions (assuming you have set them up to do so through your bank's [customization](getting_started_customization.md#other-emails) and any [Partner Groups](pm_partner_groups.md#do-you-want-to-send-deadline-reminders-to-them-every-month) they belong to. If you import your Partners, they will be imported as Uninvited. @@ -30,7 +30,7 @@ The 'standard' sequence is for the Partners to fill in some information in the P However, many banks get the information from their Partners in other ways. Some, for instance, will fill in the information themselves while on a call with the Partner. ## Awaiting review -Once a Partner has been invited, they will use the "Edit my Profile" function in their view of the system to provide the information. They can save their progress, and then "save and review", then "submit for approval" - which changes the status to "Awaiting review. This Partner will now appear on your dashboard, in the "Partner Approvals" section. The Partner will not be able to make Requests until they are approved. +Once a Partner has been invited, they will use the "Edit my Profile" function in their view of the system to provide the information. They can save their progress, and then "save and review", then "submit for approval" - which changes the status to "Awaiting review". This Partner will now appear on your dashboard, in the "Partner Approvals" section. The Partner will not be able to make Requests until they are approved. ## Approved Approved Partners can make Requests. diff --git a/docs/user_guide/bank/pm_partner_user_admin.md b/docs/user_guide/bank/pm_partner_user_admin.md index 3685fa6bd7..6e516b8c4a 100644 --- a/docs/user_guide/bank/pm_partner_user_admin.md +++ b/docs/user_guide/bank/pm_partner_user_admin.md @@ -15,4 +15,4 @@ This will bring you to a list of Users for that Partner. Here you can invite n ![](images/partners/partners_user_management.png) -[Prior - Partner reactivation](pm_Partner_reactivation.md) [Next: Other Partner information](pm_other_information.md) +[Prior - Partner reactivation](pm_partner_reactivation.md) [Next: Other Partner information](pm_other_information.md) diff --git a/docs/user_guide/bank/pm_request_distribution_cycle.md b/docs/user_guide/bank/pm_request_distribution_cycle.md index 5f516525fc..2c0214daef 100644 --- a/docs/user_guide/bank/pm_request_distribution_cycle.md +++ b/docs/user_guide/bank/pm_request_distribution_cycle.md @@ -12,11 +12,11 @@ So, how does working with Requests from Partners work? 2/ They get an email confirming that the Request has been sent to you. -3/ This Request appears in the system in the following places: a) your [dashbboard](essentials_dashboard.md), under "Outstanding Requests", and in the [Requests](essentials_requests.md) view. +3/ This Request appears in the system in the following places: a) your [dashboard](essentials_dashboard.md), under "Outstanding Requests", and in the [Requests](essentials_requests.md) view. 4/ You view the Request, and click "Fulfill Request" (you also have the option of cancelling it) -5/ That marks the Request as "started" -- so other staff don't grab the same Request to start working on it, and brings up a new [Distribution] for the partner, with the information we can pre-fill, pre-filled. +5/ That marks the Request as "started" -- so other staff don't grab the same Request to start working on it, and brings up a new [Distribution](essentials_distributions.md) for the partner, with the information we can pre-fill, pre-filled. 6/ You fill in the rest of the information, and make any adjustments required. diff --git a/docs/user_guide/bank/pm_requesting_recertification.md b/docs/user_guide/bank/pm_requesting_recertification.md index 9d9a97e6cb..b3774518a7 100644 --- a/docs/user_guide/bank/pm_requesting_recertification.md +++ b/docs/user_guide/bank/pm_requesting_recertification.md @@ -2,7 +2,7 @@ From time to time, perhaps annually, you may want to confirm that the information your Partner has provided is still correct. That is what "request recertification" is for. -[!WARN] Once you request recertification, the Partner will not be able to enter Requests until you have approved them again!! +[!WARNING] Once you request recertification, the Partner will not be able to enter Requests until you have approved them again!! If you request recertification from a Partner, they will receive an email requesting that they update their information, and their status will change to "Recertification required". @@ -27,12 +27,12 @@ Thank you and have a great day! To request recertification, go to the All Partners screen (click on "Partner Agencies", then "All Partners" in the left hand menu), then click the red "Request Recertification" button beside the Partner. A confirmation window will pop up - check that you picked the right Partner, and click "OK". -![](images/partners/partners_recertification.png) +![Request Recertification button](images/partners/partners_recertification.png) This will change the status of the Partner to "Recertification required". -Once they have made their changes, you can [approve](pm_approving_a_partner.md) them again, which will restore their ability to make Pequests. +Once they have made their changes, you can [approve](pm_approving_a_partner.md) them again, which will restore their ability to make Requests. -[!Note] They have a "Submit for Approval" button, which would change their status to "Waiting for Approval", and make them appear in your dashboard, but you can bypass that step) +[!NOTE] They have a "Submit for Approval" button, which would change their status to "Awaiting review", and make them appear in your dashboard, but you can bypass that step. [Prior -- Approving a partner](pm_approving_a_partner.md) [Next -- making a partner inactive ](pm_making_a_partner_inactive.md) diff --git a/docs/user_guide/bank/readme.md b/docs/user_guide/bank/readme.md index db2d2f23ee..2de3bcb55e 100644 --- a/docs/user_guide/bank/readme.md +++ b/docs/user_guide/bank/readme.md @@ -13,7 +13,7 @@ This user guide is meant for users of Human Essentials at essentials banks. 1. [Levels of access](getting_started_access_levels.md) 2. [User management](getting_started_user_management.md) 6. [Partner Agencies](getting_started_partners.md) - 7. [Donation sites](getting_started_donation_sites.md) + 7. [Donation sites](community_donation_sites.md) 3. Everyday essentials 1. [Your dashboard](essentials_dashboard.md) 2. [Donations](essentials_donations.md) @@ -27,31 +27,32 @@ This user guide is meant for users of Human Essentials at essentials banks. 3. [Importing partners](pm_importing_partners.md) 4. [Adding a partner](pm_adding_a_partner.md) 5. [Partner Groups](pm_partner_groups.md) - 6. [Editing a Partner](pm_editing partners.md) + 6. [Editing a Partner](pm_editing_a_partner.md) 7. The partner approval cycle 1. [Inviting a partner](pm_inviting_a_partner.md) 2. [Partner profiles](pm_partner_profiles.md) 3. [Approving a partner](pm_approving_a_partner.md) 4. [Requesting recertification](pm_requesting_recertification.md) 8. [Making a partner inactive](pm_making_a_partner_inactive.md) - 9. [Reactivating a partner](pm_parter_reactivation.md) + 9. [Reactivating a partner](pm_partner_reactivation.md) 10. [Administering partner users](pm_partner_user_admin.md) 11. [Other partner information](pm_other_information.md) 12. [Announcements](pm_announcements.md) + 13. [Partner reminder emails](pm_partner_reminders.md) 5. Inventory 1. [Items](inventory_items.md) 2. [Storage Locations](inventory_storage_locations.md) - 2. [Audits](inventory_audits.md) - 3. [Kits](inventory_kits.md) - 4. [Barcodes](inventory_barcodes.md) - 5. [Inventory Adjustments](inventory_barcodes.md) - 6. [Transfers](inventory_transfers.md) + 3. [Audits](inventory_audits.md) + 4. [Kits](inventory_kits.md) + 5. [Barcodes](inventory_barcodes.md) + 6. [Inventory Adjustments](inventory_adjustments.md) + 7. [Transfers](inventory_transfers.md) 6. Your community 1. [Product Drives](community_product_drives.md) 2. [Product Drive Participants](community_product_drive_participants.md) - 2. [Donation Sites](community_donation_sites.md) - 3. [Vendors](community_vendors.md) - 4. [Manufacturers](community_manufacturers.md) + 3. [Donation Sites](community_donation_sites.md) + 4. [Vendors](community_vendors.md) + 5. [Manufacturers](community_manufacturers.md) 7. Getting information out of the system 1. [Exports](exports.md) 2. Reports @@ -60,7 +61,7 @@ This user guide is meant for users of Human Essentials at essentials banks. 3. [Trends](reports_trends.md) 4. Specialty reports 1. [Annual Survey](reports_annual_survey.md) - 2. [Distributions by county](reports_distribution_by_county.md) + 2. [Distributions by county](reports_distributions_by_county.md) 3. [Manufacturer donations](reports_manufacturers_donations.md) 4. [Activity graph](reports_activity_graph.md) 5. [History](reports_history.md) @@ -70,10 +71,10 @@ This user guide is meant for users of Human Essentials at essentials banks. 11. Special Topics 1. [Custom Units](special_custom_units.md) 12. Emails - 1. [Distribution Mailer](distribution_mailer_Preview.md) + 1. [Distribution Mailer](distribution_mailer_preview.md) 2. [Organization Mailer](organization_mailer_preview.md) 3. [Partner Mailer ](partner_mailer_preview.md) 4. [Reminder Deadline Mailer](reminder_deadline_mailer_preview.md) 5. [Request Mailer](request_mailer_preview.md) - 6. [Requests Confirmation Mailer](requests_confirmation_mailer_preview,md) + 6. [Requests Confirmation Mailer](requests_confirmation_mailer_preview.md) 7. [User Mailer](user_mailer_preview.md) \ No newline at end of file diff --git a/docs/user_guide/bank/reports_manufacturers_donations.md b/docs/user_guide/bank/reports_manufacturers_donations.md index 01fe25121f..be53b71487 100644 --- a/docs/user_guide/bank/reports_manufacturers_donations.md +++ b/docs/user_guide/bank/reports_manufacturers_donations.md @@ -1,6 +1,6 @@ # Manufacturers Donations Report -To access this report, click 'Reports", then "Donations - Manufacturers" +To access this report, click "Reports", then "Donations - Manufacturer" ![manufacturer_donations_report_default](images/reports/reports_manufacturer_donations_1.png) diff --git a/docs/user_guide/bank/requests_confirmation_mailer_preview,md b/docs/user_guide/bank/requests_confirmation_mailer_preview.md similarity index 100% rename from docs/user_guide/bank/requests_confirmation_mailer_preview,md rename to docs/user_guide/bank/requests_confirmation_mailer_preview.md