documentation

pull/11/head
Dan Gowans 2025-04-16 14:06:56 -04:00
parent 5e2b90f2a2
commit 0b767d6b88
10 changed files with 52 additions and 3 deletions

View File

@ -5,13 +5,13 @@
[![sunrise-cms](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/26a4bi&style=flat&logo=cypress)](https://cloud.cypress.io/projects/26a4bi/runs) [![sunrise-cms](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/26a4bi&style=flat&logo=cypress)](https://cloud.cypress.io/projects/26a4bi/runs)
[![Coverage Testing](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml) [![Coverage Testing](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml/badge.svg)](https://github.com/cityssm/sunrise-cms/actions/workflows/coverage.yml)
![Sunrise CMS](./docs/socialPreview.png) ![Sunrise CMS](./docs/images/socialPreview.png)
🚧 **In development** 🚧 🚧 **In development** 🚧
**A web-based application to assist cemetery managers with managing their cemetery records.** **A web-based application to assist cemetery managers with managing their cemetery records.**
![Burial Site View](./docs/burialSite-view.png) ![Burial Site View](./docs/images/burialSite-view.png)
This is a major refactoring of the now archived This is a major refactoring of the now archived
[Lot Occupancy System](https://github.com/cityssm/lot-occupancy-system), [Lot Occupancy System](https://github.com/cityssm/lot-occupancy-system),

View File

@ -4,7 +4,7 @@
**Thank you for taking the time to read the Sunrise Cemetery Management System (CMS) documentation.** **Thank you for taking the time to read the Sunrise Cemetery Management System (CMS) documentation.**
![Burial Site View](./burialSite-view.png) ![Burial Site View](./images/burialSite-view.png)
**In development** **In development**

View File

@ -3,3 +3,20 @@
[Help](https://cityssm.github.io/sunrise-cms/docs/) [Help](https://cityssm.github.io/sunrise-cms/docs/)
# Burial Sites # Burial Sites
![Burial Site Update View](./images/burialSite-update.png)
Burial sites are the locations within [cemeteries](./cemeteries.md) where interments take place.
## Key Burial Site Fields
**Burial Site Name**<br />
Can be up to five segments, each with their own requirements.
Can be prepended with the cemetery key.
Must be unique system wide.
**Geographic Location**<br />
Used to show the burial site location on a map.
**Cemetery SVG ID**<br />
Used to highlight the burial site within the cemetery's SVG image.

View File

@ -3,3 +3,21 @@
[Help](https://cityssm.github.io/sunrise-cms/docs/) [Help](https://cityssm.github.io/sunrise-cms/docs/)
# Cemeteries # Cemeteries
![Update Cemetery View](./images/cemetery-update.png)
Cemeteries are groupings of [burial sites](./burialSites.md).
## Key Cemetery Fields
**Cemetery Key**<br />
Can be prepended to burial site names.
**Parent Cemetery**<br />
Helpful when breaking larger cemeteries into smaller sections.
**Geographic Location**<br />
Used to show the cemetery location on a map.
**Image**<br />
An SVG image of the cemetery, optional labelled to allow for burial site highlighting.

View File

@ -3,3 +3,17 @@
[Help](https://cityssm.github.io/sunrise-cms/docs/) [Help](https://cityssm.github.io/sunrise-cms/docs/)
# Contracts # Contracts
![Contract Update View](./images/contract-update.png)
Contracts track preneed [burial site](./burialSites.md) reservations,
and at-need burial site interments.
## Key Contract Fields
**End Date**<br />
When set, the end date is considered the date the contract no longer applies.
In the case of a preneed contract, an end date should be applied when the recipient passes
and is interred in the burial site.
In the case of an at-need contract, the end date should remain empty as long as the deceased
is interred in the burial site.

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

View File

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

View File

Before

Width:  |  Height:  |  Size: 819 KiB

After

Width:  |  Height:  |  Size: 819 KiB