Skip to content

Commit

Permalink
Merge pull request #2 from MasterFacilityList/update-
Browse files Browse the repository at this point in the history
updating docs
  • Loading branch information
bmarika committed Oct 1, 2015
2 parents f8199a0 + b76ea8d commit 6be82df
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 40 deletions.
7 changes: 6 additions & 1 deletion docs/01_intro.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Introduction
===============================
TODO
This is the publicly accessible side of the Master Facility List.
The main focus of this side is to allow easy location of facilities
and community health units, mainly through search.

The homepage has a prominent search field, which can be used to lookup
facilities by name, services, code e.t.c.

.. figure:: /_images/facilities/01_home.png
:scale: 100%
Expand Down
104 changes: 70 additions & 34 deletions docs/02_facilities.rst
Original file line number Diff line number Diff line change
@@ -1,100 +1,136 @@
Locating Facilities Within the Master Facility List
====================================================
TODO

Facilities in the MFL can be located via search and geolocation.

Location Through Search
++++++++++++++++++++++++
TODO
The homepage has a search field that searches facilities by their code, name e.t.c.

.. figure:: /_images/facilities/02_searching.png
:scale: 100%
:alt: Searching Facilities

The results of the search are shown alongside the advanced search. Using the advanced
search the query can be fine tuned e.g. listing facilities in a certain ward.

.. figure:: /_images/facilities/03_search_results.png
:scale: 100%
:alt: Searching Facilities

.. figure:: /_images/facilities/04_b_detailed_page.png
The facility advanced search can also be accessed directly by selecting the find facilities
button in the top navigation bar.

.. figure:: /_images/facilities/06_list_facilities.png
:scale: 100%
:alt: Detailed Facility View
:alt: Listing Facilities

The advanced search form on the left has fields that can further specify your search.

.. figure:: /_images/facilities/04_b_detailed_page.png
There's an export facilities option that enables users to export and download the filtered
facilities in excel format.

.. figure:: /_images/facilities/07_export_facilities.png
:scale: 100%
:alt: Export Facilities

.. figure:: /_images/facilities/07_b_export_facilities.png
:scale: 100%
:alt: Exported Facilities


Opening one facility show more details about the facility. The basic details of the facility
are displayed on top. Below the basic details, the facility's services, location on a map,
community units and (regulation) departments are displayed in tabs.

The facility services tab shows the services that the facility offers.

.. figure:: /_images/facilities/04_detailed_page.png
:scale: 100%
:alt: Detailed Facility View

.. figure:: /_images/facilities/04_c_detailed_page.png
The facility's administrative unit (county, sub-county and ward) links to geolocation of facilities
within the selected facility administrative unit.

.. figure:: /_images/facilities/04_e_detailed_page.png
:scale: 100%
:alt: Detailed Facility View

.. figure:: /_images/facilities/04_d_detailed_page.png
A printable version of the facility details is available by pressing the print
button.

.. figure:: /_images/facilities/04_f_detailed.png
:scale: 100%
:alt: Detailed Facility View

.. figure:: /_images/facilities/04_detailed_page.png
The regulation tab shows the departments that are in the facility.

.. figure:: /_images/facilities/04_b_detailed_page.png
:scale: 100%
:alt: Detailed Facility View

The community health units tab displays the community health units that are
attached to the facility. Clicking on one unit opens up more details about
the unit.

.. figure:: /_images/facilities/04_e_detailed_page.png
.. figure:: /_images/facilities/04_c_detailed_page.png
:scale: 100%
:alt: Detailed Facility View

The show facility on map tab displays the position of the facility in
the ward the facility is in.

.. figure:: /_images/facilities/04_f_detailed.png
.. figure:: /_images/facilities/04_d_detailed_page.png
:scale: 100%
:alt: Detailed Facility View

Rating A Facility
-----------------------------------------------------

Rating A Facility's Services
+++++++++++++++++++++++++++++
Users are able to rate facility services by selecting the view service rating
of the service to be rated. Rating is restricted to one service per day.

.. figure:: /_images/facilities/05_a_rating.png
:scale: 100%
:alt: Detailed Facility View


Location Through the Geo-locator
Location Through the Geo-locator
+++++++++++++++++++++++++++++++++++

TODO
The geolocator is the second way of locating facilities. The geolocator is accessed
using the facility geolocator button in the top navigation. The page shows the map of
Kenya with all 47 counties. The map has a heatmap showing concentration of facilities
in an area.

.. figure:: /_images/facilities/08_facility_geolocator.png
:scale: 100%
:alt: Facility Geo-locator

Clicking on one county brings up the selected county's sub counties.

.. figure:: /_images/facilities/08_facility_geolocator_county.png
:scale: 100%
:alt: County Drill Down

Clicking on one sub-county brings up the selected sub-county's wards.

.. figure:: /_images/facilities/08_facility_geolocator_subcounty.png
:scale: 100%
:alt: Sub-county Drill Down

The ward level is the lowest administrative unit available.

.. figure:: /_images/facilities/08_facility_geo_locator_ward.png
:scale: 100%
:alt: Ward Drill Down

On the left of the map, there's a button that can be used to view facilities
in the administrative unit, in this case, the ward.

.. figure:: /_images/facilities/08_facility_geolocator_link_to_advanced_search.png
:scale: 100%
:alt: Link to Advanced Search

Advanced Search
+++++++++++++++++++
TODO

.. figure:: /_images/facilities/06_list_facilities.png
:scale: 100%
:alt: Listing Facilities

Exporting Facilities
----------------------------

.. figure:: /_images/facilities/07_export_facilities.png
:scale: 100%
:alt: Export Facilities

.. figure:: /_images/facilities/07_b_export_facilities.png
:scale: 100%
:alt: Exported Facilities

.. toctree::
:maxdepth: 2

18 changes: 15 additions & 3 deletions docs/03_community_units.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@

Community Health Units
Community Health Units (CHUs)
================================

Listing Community Health Units
++++++++++++++++++++++++++++++++++
CHUs are health service structures with a defined geographical area and assigned to a facility.


Listing CHUs
+++++++++++++

Just like facilities, CHUs have an advanced search, available under the community units link
on the top navigation bar.

.. figure:: /_images/facilities/09_community_units.png
:scale: 100%
:alt: Community Health Units List

Community Health Detail View
++++++++++++++++++++++++++++++++++
The CHU detail view displays the CHU basic details and also its location on a map based on
the attached facility.

.. figure:: /_images/facilities/09_comunity_unit_detail.png
:scale: 100%
:alt: Community Health Unit Detail


Providing Feedback on A Community Health Unit
+++++++++++++++++++++++++++++++++++++++++++++++++++
CHUs can also be rated by clicking the rate chul button.

.. figure:: /_images/facilities/09_rating_community_unit.png
:scale: 100%
:alt: Rating Community Health Unit

6 changes: 4 additions & 2 deletions docs/04_downloads.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Downloads
=======================
TODO
==========

The downloads section offers documents and other material related to the MFL e.g. the
MFL Implementation guide.

.. figure:: /_images/facilities/10_downloads.png
:scale: 100%
Expand Down

0 comments on commit 6be82df

Please sign in to comment.