diff --git a/docs/README.md b/docs/README.md index 2b49be15..8b8106e8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,5 +4,10 @@ **Thank you for taking the time to read the documentation.** +![Lot Occupancy View](images/lotOccupancyView.png) + +[**Terminology**](terminology.md)
+Understanding the key terms used in the Lot Occupancy System. + [**Map Images**](mapImages.md)
How to create images compatible with the Lot Occupancy System. \ No newline at end of file diff --git a/docs/images/lotOccupancyView.png b/docs/images/lotOccupancyView.png new file mode 100644 index 00000000..9d86ee34 Binary files /dev/null and b/docs/images/lotOccupancyView.png differ diff --git a/docs/terminology.md b/docs/terminology.md new file mode 100644 index 00000000..b983d30c --- /dev/null +++ b/docs/terminology.md @@ -0,0 +1,26 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) +• +[Help](https://cityssm.github.io/lot-occupancy-system/docs/) + +# Terminology + +_Note that is is possible to substitute the default terminology using the application's config file._ + +| Term | Description | Cemetery System Alias Example | +| --------- | ---------------------------------------------- | ----------------------------- | +| Map | The highest level object, a group of lots. | Cemetery | +| Lot | The smallest occupiable piece of land. | Burial Site | +| Occupancy | A reservation on a lot for a specific purpose. | Occupancy | +| Occupant | A person associated with a lot occupancy. | Occupant | + +For example in the context of a cemetery system, John Doe has passed away and has been interred. + +- John Doe would be considered an **occupant**. +- An **occupancy** record would be created with **no end date** and associated with his **burial site (lot)** of choice. +- The **burial site (lot)** is associated with the **cemetery (map)** where John is buried. + +For example in the context of a marina, Jane Smith and her boat are renting a slip for a week. + +- Jane Doe, and possibly the others on her boat, would be considered **renters (occupants)**. +- A **reservation (occupancy)** record would be created for the duration of her stay, and associated with the **slip (lot)** of choice. +- The **slip (lot)** is associated with the **marina (map)** where the slip is located. diff --git a/gulpfile.js b/gulpfile.js index aa104277..60d86389 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -8,7 +8,7 @@ const publicSCSSDestination = "public/stylesheets"; const publicSCSSFunction = () => { return gulp .src("public-scss/*.scss") - .pipe(sass({ outputStyle: "compressed" }).on("error", sass.logError)) + .pipe(sass({ outputStyle: "compressed", includePaths: ["node_modules"] }).on("error", sass.logError)) .pipe(gulp.dest(publicSCSSDestination)); }; gulp.task("public-scss", publicSCSSFunction);