Merge pull request #334 from KathyReid/docs-2016

Docs 2016

docs/03-administer/altering-rego-details.md

@@ -0,0 +1,89 @@
+Altering registration details
+=============================
+
+Introduction
+------------
+
+Zookeepr uses a invoice based system for registrations and registration items. For the item purchasing and distribution to go smoothly it is important to work with this system.
+
+DO NOT use the manual item section for invoice items, it will make a mess. The custom item selection is for special cases, typically to reassure an employer that the conference supply water or something... You can enter "T-Shirt" or similar, it will look like a T-Shirt but it will not be a T-Shirt, they will not get a T-Shirt you will get unhappy.
+
+Change T-Shirt size
+-------------------
+The request is to change from a Medium T-Shirt to a Large T-Shirt.
+
+1. Go to the profile of the person to edit
+2. Click the "New manual invoice" link
+3. In the Add Product Line section select T-Shirt, Men's Medium.
+4. Press the related Add button.
+5. In the upper invoice area change the quantity to -1. Leave the price alone.
+6. In the Add Product Line section select T-Shirt, Men's Large.
+7. Press the related Add button.
+8. Double check that the invoice total is $0.
+9. Press the Save and View button
+10. Double check that things look ok.
+
+The invoice will be automatically marked as paid and their swag inventory updated.
+
+Add accommodation to registered user
+------------------------------------
+The request is from someone to promised to accommodate themselves to get accommodation at Toad Hall.
+
+1. Go to the profile of the person to edit
+2. Click the "New manual invoice" link
+3. In the Add Product Line section select Accommodation, Toad Hall.
+4. Press the related Add button.
+5. Double check that the invoice builder looks ok.
+6. Press the Save and View button
+7. Triple check that resulting invoice looks correct.
+
+The user will need to pay the outstanding amount before they receive their accommodation. You will need to send them an email informing them of this.
+
+Upgrade a registration from hobbyist to professional
+-----------------------------------------------------
+A user has registered as a hobbyist but now their work has agreed to pay for a professional ticket.
+
+1. Ask the user if they want the hobbyist amount refunded to them, or if they want an invoice for the outstanding balance.
+
+### Refund and create a new invoice
+
+2. Go to the profile of the person to edit
+3. Click the "New manual invoice" link
+4. In the Add Product Line section select Ticket, Hobbyiest Ticket or Earlybird Hobbyist Ticket as appropriate.
+5. Change the quantity to -1, leave the price alone.
+6. Press the related Add button.
+7. Press the Save and View button
+8. Confirm that the invoice looks ok and there is a negative amount.
+9. Press the Save and View button
+10. If you have access to the merchant gateway system, process this refund and mark it as paid. If not, update the ticket or create a new ticket to ensure that they payment is processed.
+11. Go to the profile of the person to edit again
+12. Click the "New manual invoice" link
+13. In the Add Product Line section select Ticket, Professional Ticket.
+14. Press the related Add button.
+15. Press the Save and View button
+16. Confirm that the invoice looks ok and there is a positive amount owed.
+
+The user's employer will need to pay the outstanding amount. You will need to send the user informing them of this providing a link to the relevant invoice.
+
+### Invoice the outstanding balance
+
+2. Go to the profile of the person to edit
+3. Click the "New manual invoice" link
+4. In the Add Product Line section select Ticket, Hobbyiest Ticket or Earlybird Hobbyist Ticket as appropriate.
+5. Change the quantity to -1, leave the price alone.
+6. Press the related Add button.
+4. In the Add Product Line section select Ticket, Professional Ticket.
+6. Press the related Add button.
+7. Check that the invoice looks ok and there is an reasonable amount owed.
+9. Press the Save and View button
+10. Double check that the resulting invoice looks ok.
+
+The user's employer will need to pay the outstanding amount. You will need to send the user informing them of this providing a link to the relevant invoice.
+
+
+Fixing a mistake in a admin created invoice
+-------------------------------------------
+
+If you create an invoice and make a mistake you can void the invoice. This will make it as if it didn't exist, it will not refund amounts of money already paid.
+
+Voiding is best done quickly before the user is aware of the invoice. If the invoice has been paid then a refund must be processed.

docs/03-administer/index.md

@@ -0,0 +1,14 @@
+Administering ZooKeepr
+=============================
+
+Introduction
+------------
+
+This documentation provides a number of tools and tips for those charged with Administering ZooKeepr - affectionately known as ZooKeepr-ers. If you are reading this documentation then you are probably a ZooKeepr-er. *Congratuations!*
+
+Tasks covered in this documentation
+-----------------------------------
+
+We currently have documentation for the following tasks;
+
+* [Altering registrations](altering-rego-details.md) - this is one of the most annoying parts of administering ZooKeepr. Read this to know how to alter a Delegate's registration once they have already registered.