rubyforgood · cielf · Jul 21, 2024 · Jun 19, 2024 · Jun 23, 2024 · Jun 25, 2024
diff --git a/doc/user_guide/bank/asking_for_changes.md b/doc/user_guide/bank/asking_for_changes.md
@@ -0,0 +1,9 @@
+# Asking for changes
+
+Although we are a small team with a long list of tweaks and improvements that we are working toward,  we do welcome ideas for how Human Essentials can support your work better.  
+
+The best ways to get those to us are through the Slack channel or by coming to the Stakeholder Circle and raising them there.
+
+The Stakeholder Circle has the advantage of being able to talk live to other banks *and* the development team in the same space.   We've had a lot of "Oh, we didn't realize that" moments in these meetings that directly result in changes to the system.
+
+(The Slack channel, on the other hand, is open every day.)
diff --git a/doc/user_guide/bank/community_donation_sites.md b/doc/user_guide/bank/community_donation_sites.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/community_manufacturers.md b/doc/user_guide/bank/community_manufacturers.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/community_product_drives.md b/doc/user_guide/bank/community_product_drives.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/community_vendors.md b/doc/user_guide/bank/community_vendors.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/essentials_calendar.md b/doc/user_guide/bank/essentials_calendar.md
@@ -0,0 +1 @@
+Not yet written (We have someone working on it though as of 20240719)
diff --git a/doc/user_guide/bank/essentials_dashboard.md b/doc/user_guide/bank/essentials_dashboard.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/essentials_distributions.md b/doc/user_guide/bank/essentials_distributions.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/essentials_donations.md b/doc/user_guide/bank/essentials_donations.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/essentials_purchases.md b/doc/user_guide/bank/essentials_purchases.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/essentials_requests.md b/doc/user_guide/bank/essentials_requests.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/exports.md b/doc/user_guide/bank/exports.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/getting_started_access_levels.md b/doc/user_guide/bank/getting_started_access_levels.md
@@ -0,0 +1,47 @@
+DRAFT USER GUIDE
+# Levels of Access
+
+There are 4 different levels of access in the system:
+1. Organization Admin
+2. Organization User
+3. Partner
+4. Super Admin
+
+(We are currently discussing adding a user who is restricted to a specific location, but we don't have it yet)
+
+## Organization Admin
+
+Organization Admins are the top-level user at your essentials bank.  They can do everything an Organization User (see below) can do, plus: 
+
+- Administer the users for your bank ( see [User Management](getting_started_user_management.md))
+- Administer the users for your partners ( see [Partner User Management](pm_partner_user_admin.md))
+- Finalize audits (see [Audits](inventory_audits.md))
+- Customize organization settings( see [Customization](getting_started_customization.md))
+
+## Organization User
+This is your basic user for your bank -- they can do all the data entry except for those things reserved for the Organization Admin, above.  Organization Users have the right to:
+
+- Enter donations, purchases, distributions
+- Fulfil requests
+- View pickup and delivery calendars
+- Administer Partners (excluding partner user management)
+- Perform Audit data entry (finalization is reserved for the Organization Admin)
+- Manage the Community information
+- View all the bank-level reports
+
+## Partner
+Partner users' access is, of course, limited to the scope of the Partner they belong to.
+Within that scope, they can:
+- Edit their partner profile
+- Submit requests (if the Partner has been approved)
+- View their distributions
+- Administer families and children (only if they are allowed to make Child Requests (this can be limited by the Org Admin,  see [Customization](getting_started_customization.md) )) (note,  the other user types cannot see this information)
+
+## Super Admin
+This bit is for information only -- A limited number of Human Essentials staff have a superadmin role that allows us to perform the following duties:
+- Review and approve Account requests
+- Make system-wide announcements
+- Administer users (we need it because every once in awhile, the organization admin for a bank will leave without promoting someone else to that role.)
+- Administer "Base Items"
+- Administer the list of NDBN members
+- Administer some organization settings [TODO:  Raise the question of whether we *should* be administering most of this -- we don't have rights to change any of the more recently added values on the org.]
diff --git a/doc/user_guide/bank/getting_started_customization.md b/doc/user_guide/bank/getting_started_customization.md
@@ -0,0 +1 @@
+not yet written
diff --git a/doc/user_guide/bank/getting_started_donation_sites.md b/doc/user_guide/bank/getting_started_donation_sites.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/getting_started_inventory.md b/doc/user_guide/bank/getting_started_inventory.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/getting_started_partners.md b/doc/user_guide/bank/getting_started_partners.md
@@ -0,0 +1,25 @@
+DRAFT USER GUIDE
+# Getting started -- partners
+
+## Things you need to know about partners before deciding how you are handling them
+
+1/  You need to have your partners in the system to be able to record distributions to them.
+
+2/  However,  if you're not ready to have your partners make requests yet, that's ok -- you can put them in the system without inviting them.   You'll still be able to record what you are distributing to them.
+
+3/  You can import all your partners at once.  You can only import partners once, though -- this is a precaution to make sure we don't accidently create duplicates.
+
+4/  The usual way to handle bringing on partners to be able to make requests is to invite them,  then have them fill in their profile before approving them, so that you get the information from them that your bank needs for grants, etc.   However, if that's not how you want to work,  it is also possible to invite and approve them in one step.
+
+5/  A lot of banks set up a partner as a proxy for their direct distribution.  This is allowed, and you can switch back and forth between being a bank and a partner with the same login  
+
+## Adding a single partner
+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)
+
+Further details on adding a partner can be found [here](pm_adding_a_partner.md)
+
+## Importing partners
+For details on how to do a bulk import of your partners, please click [here](pm_importing_partners.md)
diff --git a/doc/user_guide/bank/getting_started_storage_locations.md b/doc/user_guide/bank/getting_started_storage_locations.md
@@ -0,0 +1,35 @@
+DRAFT USER GUIDE
+# Getting Started -- Storage Locations
+
+A bank can have multiple storage locations -- these range from warehouses down to space in people's houses.  You need at least one storage location in the system.
+
+Each storage location has its own inventory of a common list of items (e.g. different sizes of diapers)
+
+When you are inputting donations, or purchases, you will specify the storage location, and the donated/purchased items will be added to that storage location's inventory.  Similarly, when you make distributions, you choose a storage location, and can see the inventory levels for each item before committing to the distribution.
+
+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)
+
+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)
+
+Either of these will bring up the new storage location screen
+
+![navigation](images/new_storage_location.png)
+
+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]
+
+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)
+
+Next step:  [Entering or uploading your initial partner list](getting_started_partners.md) 
diff --git a/doc/user_guide/bank/getting_started_user_management.md b/doc/user_guide/bank/getting_started_user_management.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/images/gs_just_starting_step_1.png b/doc/user_guide/bank/images/gs_just_starting_step_1.png
diff --git a/doc/user_guide/bank/images/gs_just_starting_step_2.png b/doc/user_guide/bank/images/gs_just_starting_step_2.png
diff --git a/doc/user_guide/bank/images/gs_storage_locations_navigation.png b/doc/user_guide/bank/images/gs_storage_locations_navigation.png
diff --git a/doc/user_guide/bank/images/new_storage_location.png b/doc/user_guide/bank/images/new_storage_location.png
diff --git a/doc/user_guide/bank/images/storage_location_index.png b/doc/user_guide/bank/images/storage_location_index.png
diff --git a/doc/user_guide/bank/intro_i.md b/doc/user_guide/bank/intro_i.md
@@ -0,0 +1,36 @@
+DRAFT USER GUIDE
+
+# Is Human Essentials right for you? (what we help with and what we don't)
+## Human Essentials is a free system for essentials banks 
+Human Essentials is for essentials banks -- by which we mean organizations that distribute essentials (diapers, period products, etc) to other organizations that work directly with people in need.
+
+If you *only* deal directly with people in need,  this is probably not the system for you.
+
+## We are an all-volunteer organization 
+
+We can offer this system for free because we are an all-volunteer organization.   We have
+sponsors who provide funding or in-kind services for the servers that the system runs on, but changes/support can take time.  
+
+## What we help with
+- managing your partners
+  - gathering the information about your partners that you need
+  - your request / distribution cycle (partner agencies can provide requests to you through the system, and you fulfill  them)
+  - monthly reminders to the partners re request deadlines
+  - calendar that shows when you've scheduled pickups and deliveries
+- inventory
+  - when you record donations, purchases, and distributions, your inventory record is automatically adjusted as of the date/time you enter the information
+  - audits and inventory adjustments
+  - handles multiple storage locations
+  - making up kits for distribution from existing inventory (this is mostly used by our period supply focused banks)
+- community management
+  - keeping track of your donation sites, product drives (and participants)
+- reporting
+  - yearly report with much of the information the NDBN annual survey requires drawn from your activity in the system
+  - itemized distribution breakdown over time
+  - trend reporting
+## Things we don't help with
+- general business needs (like payroll and office supplies and the like)
+- volunteer coordination
+- donor tax receipts 
+- direct distribution -- there are some things that help with that in the partner side, and some banks run a partner for their direct distribution, but it is not our strength.
+
diff --git a/doc/user_guide/bank/intro_ii.md b/doc/user_guide/bank/intro_ii.md
@@ -0,0 +1,29 @@
+DRAFT USER GUIDE
+
+# Support
+
+There are a few ways to get support -- some are better than others.
+## For banks:
+### Slack 
+We highly recommend that you become a member of the human essentials Slack.  Here's a link to an invite:  https://human-essential.slack.com/join/shared_invite/zt-bfa8tymd-d8Ks3Mq000COcRe~nfs~zg#/shared-invite/email
+
+
+It's a good place to ask about how other banks *actually* use the system 
+    -- any workarounds for things that don't 100% match how the system is set up.
+       (for instance, 1 bank has added an item that they use for the partners to report how many children are served by a bulk request.)
+
+It's often the quickest way to get support from the human essentials team as well, and the easiest way to interact with the development team.
+### Support tickets
+There is a link to submit a support ticket is at the bottom of the "Need Help?"  screen.   This will get to us, 
+    but it will take longer.  We generally look at these about once a week, on Sundays.
+### Email
+
+You can email info@humanessentials.app.   We generally look at these about once a week, on Sundays.
+
+### Stakeholder circle
+We hold a stakeholder circle the first Wednesday of every month at 6:00pm Eastern Time.  There will be other banks there, plus a couple members of the Human Essentials team.
+We publish the zoom, and (when we remember) in the Announcements in Human Essentials.
+
+## For partners:
+We recommend that the partners seek support through the banks.  Each bank has their own particular way of doing things, and the development team doesn't want to mess that up.
+
diff --git a/doc/user_guide/bank/inventory_adjustments.md b/doc/user_guide/bank/inventory_adjustments.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_audits.md b/doc/user_guide/bank/inventory_audits.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_barcodes.md b/doc/user_guide/bank/inventory_barcodes.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_items.md b/doc/user_guide/bank/inventory_items.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_kits.md b/doc/user_guide/bank/inventory_kits.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_storage_locations.md b/doc/user_guide/bank/inventory_storage_locations.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/inventory_transfers.md b/doc/user_guide/bank/inventory_transfers.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_adding_a_partner.md b/doc/user_guide/bank/pm_adding_a_partner.md
@@ -0,0 +1,2 @@
+# Adding a single partner
+To add a single partner,  you can either Click on the "Add a Partner" button in the "Getting Started" section of your dashboard (if you are, indeed, just getting started), or click "Partner Agencies" in the left-hand menu, then "All Partners", then "New Partner Agency".
diff --git a/doc/user_guide/bank/pm_announcements.md b/doc/user_guide/bank/pm_announcements.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_approving_a_partner.md b/doc/user_guide/bank/pm_approving_a_partner.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_importing_partners.md b/doc/user_guide/bank/pm_importing_partners.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_inviting_a_partner.md b/doc/user_guide/bank/pm_inviting_a_partner.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_making_a_partner_inactive.md b/doc/user_guide/bank/pm_making_a_partner_inactive.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_partner_profiles.md b/doc/user_guide/bank/pm_partner_profiles.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_partner_user_admin.md b/doc/user_guide/bank/pm_partner_user_admin.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_request_distribution_cycle.md b/doc/user_guide/bank/pm_request_distribution_cycle.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/pm_requesting_recertification.md b/doc/user_guide/bank/pm_requesting_recertification.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_activity_graph.md b/doc/user_guide/bank/reports_activity_graph.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_annual_survey.md b/doc/user_guide/bank/reports_annual_survey.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_distribution_by_county.md b/doc/user_guide/bank/reports_distribution_by_county.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_itemized_reports.md b/doc/user_guide/bank/reports_itemized_reports.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_manufacturers_donations.md b/doc/user_guide/bank/reports_manufacturers_donations.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_summary_reports.md b/doc/user_guide/bank/reports_summary_reports.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/reports_trends.md b/doc/user_guide/bank/reports_trends.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/toc.md b/doc/user_guide/bank/toc.md
@@ -0,0 +1,59 @@
+DRAFT USER GUIDE
+1. Introduction
+   1. [Is Human Essentials right for you?](intro_i.md) (what we help with and what we don't)
+   2. [Support](intro_ii.md) 
+2. Getting started
+   1. [Storage Locations](getting_started_storage_locations.md)
+   2. [Partner Agencies](getting_started_partners.md)
+   3. [Donation sites](getting_started_donation_sites.md)
+   4. [Inventory](getting_started_inventory.md)
+   5. [Customization and other organization-level info](getting_started_customization.md)
+   6. Adding your staff
+      1. [Levels of access](getting_started_access_levels.md)
+      2. [User management](getting_started_user_management.md)
+3. Everyday essentials 
+   1. [Your dashboard](essentials_dashboard.md)
+   2. [Donations](essentials_donations.md)
+   3. [Purchases](essentials_purchases.md)
+   4. [Requests](essentials_requests.md)
+   5. [Distributions](essentials_distributions.md)
+   6. [Pickups and Deliveries Calendar](essentials_calendar.md)
+4. Partner Management
+   1. [The request/distribution cycle](pm_request_distribution_cycle.md)
+   2. [Adding a partner](pm_adding_a_partner.md)
+   3. [Importing partners](pm_importing_partners.md)
+   4. [Administering partner users](pm_partner_user_admin.md)
+   4. 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)
+      5. [Making a partner inactive](pm_making_a_partner_inactive.md)
+   5. [Announcements](pm_announcements.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)
+6. Your community
+   1. [Product Drives](community_product_drives.md)
+   2. [Donation Sites](community_donation_sites.md)
+   3. [Vendors](community_vendors.md)
+   4. [Manufacturers](community_manufacturers.md)
+7. Getting information out of the system
+   1. [Exports](exports.md)
+   2. Reports
+      1. [Summary reports](reports_summary_reports.md)
+      2. [Itemized reports](reports_itemized_reports.md)
+      3. [Trends](reports_trends.md)
+      4. Specialty reports
+         1. [Annual Survey](reports_annual_survey.md)
+         2. [Distributions by county](reports_distribution_by_county.md)
+         3. [Manufacturer donations](reports_manufacturers_donations.md)
+         4. [Activity graph](reports_activity_graph.md)
+8. [User management](user_management.md)
+9. [Signing out, and other things you can access by clicking on your name](top_right_menu.md)
+[But I need to do something different!](asking_for_changes.md)
diff --git a/doc/user_guide/bank/top_right_menu.md b/doc/user_guide/bank/top_right_menu.md
@@ -0,0 +1 @@
+Not yet written
diff --git a/doc/user_guide/bank/user_management.md b/doc/user_guide/bank/user_management.md
@@ -0,0 +1 @@
+Not yet written
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Not yet written (We have someone working on it though as of 20240719)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Adding a single partner
		To add a single partner, you can either Click on the "Add a Partner" button in the "Getting Started" section of your dashboard (if you are, indeed, just getting started), or click "Partner Agencies" in the left-hand menu, then "All Partners", then "New Partner Agency".