diff --git a/docs/README.md b/docs/README.md index 12d85e2c..24438006 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ Understanding the key terms used in the Lot Occupancy System. ## πŸ‘© User Documentation [**Work Orders**](workOrders.md)
-What are work orders? How do they work? +What are work orders? How do they work? ## πŸ¦Έβ€β™€οΈ Power User Documentation @@ -23,5 +23,18 @@ Shortcuts to speed through tasks in the Lot Occupancy System. ## πŸ’Ό Administrator Documentation +[**Fee Management**](adminFees.md)
+Administer fees that apply to occupancy records. + +[**Occupancy Type Management**](adminOccupancyTypes.md)
+Maintain the types available for occupancy records. + +[**Lot Type Management**](adminLotTypes.md)
+Maintain the types available for lots. + +[**Config Table Management**](adminConfigTables.md)
+Maintain simpler, list-like tables include work order types, +work order milestone types, lot statuses, and lot occupant types. + [**Map Images**](mapImages.md)
How to create images compatible with the Lot Occupancy System. diff --git a/docs/adminConfigTables.md b/docs/adminConfigTables.md new file mode 100644 index 00000000..9fb10084 --- /dev/null +++ b/docs/adminConfigTables.md @@ -0,0 +1,25 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) +β€’ +[Help](https://cityssm.github.io/lot-occupancy-system/docs/) + +# Config Table Management + +![Config Table Management](images/adminConfigTables.png) + +The Config Table Management page updates simpler configuration tables +that are, for the most part, list-like. + +The tables that can be updated on this page include: + +- Work Order Types +- Work Order Milestone Types +- Lot Statuses (referred to as "Burial Site Statuses" in the screenshot) +- Lot Occupant Types (referred to as "Burial Site Occupant Types" in the screenshot) + +When updating any list items, it is important not to change the meaning of the items. +When in doubt, rather than renaming a list item, delete it, and create a new one instead. + +## Related Links + +- [Occupancy Type Management](adminOccupancyTypes.md) +- [Lot Type Management](adminLotTypes.md) diff --git a/docs/adminFees.md b/docs/adminFees.md new file mode 100644 index 00000000..6b0fbe41 --- /dev/null +++ b/docs/adminFees.md @@ -0,0 +1,21 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) +β€’ +[Help](https://cityssm.github.io/lot-occupancy-system/docs/) + +# Fee Management + +![Fee Management](images/adminFees.png) + +Fees can be applied to occupancy records. +Each fee includes the following properties. + +- A category, name, and description. + +- Filter options by occupancy type and/or lot type. + +- Fee and tax amounts. + +## Related Links + +- [Occupancy Type Management](adminOccupancyTypes.md) +- [Lot Type Management](adminLotTypes.md) diff --git a/docs/adminLotTypes.md b/docs/adminLotTypes.md new file mode 100644 index 00000000..8b25011e --- /dev/null +++ b/docs/adminLotTypes.md @@ -0,0 +1,10 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) +β€’ +[Help](https://cityssm.github.io/lot-occupancy-system/docs/) + +# Lot Type Management + +![Lot Type Management](images/adminLotTypes.png) + +Each lot record, refered to as a "burial site" in the screenshot, is assigned a type. +Those types can have custom data fields associated with them. diff --git a/docs/adminOccupancyTypes.md b/docs/adminOccupancyTypes.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/images/adminConfigTables.png b/docs/images/adminConfigTables.png new file mode 100644 index 00000000..5e64409d Binary files /dev/null and b/docs/images/adminConfigTables.png differ diff --git a/docs/images/adminFees.png b/docs/images/adminFees.png new file mode 100644 index 00000000..58438d31 Binary files /dev/null and b/docs/images/adminFees.png differ diff --git a/docs/images/adminLotTypes.png b/docs/images/adminLotTypes.png new file mode 100644 index 00000000..b9781b3f Binary files /dev/null and b/docs/images/adminLotTypes.png differ diff --git a/docs/images/adminOccupancyTypes.png b/docs/images/adminOccupancyTypes.png new file mode 100644 index 00000000..2746c288 Binary files /dev/null and b/docs/images/adminOccupancyTypes.png differ diff --git a/docs/workOrders.md b/docs/workOrders.md index d0ae1abe..2966ab2c 100644 --- a/docs/workOrders.md +++ b/docs/workOrders.md @@ -51,4 +51,8 @@ Milestone types are completely customizable and can be used to categorize milest The date, and optional time, track when the milestone is scheduled to be completed. Milestones appear on the main application dashboard, -and can be linked to calendar applications like Microsoft Outlook. \ No newline at end of file +and can be linked to calendar applications like Microsoft Outlook. + +## Related Links + +- [Config Table Management](adminConfigTables.md)