Remove scaffolding (#19)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,43 @@
 ---
-name: Bug report
-about: Create a report to help us improve
+name: Bug Report
+about: Use to report a bug
 title: ''
-labels: ''
+labels: bug
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Bug Report
+
+### Description
+
+Provide a brief overview of the bug encountered. Describe the behavior observed when the bug occurs and explain the behavior expected when the bug is not present.
+
+### Reproducibility
+
+- [ ] The bug is reproducible.
+- [ ] The bug is intermittent.
+- [ ] The bug occurs only under specific conditions.
+
+#### Steps to Reproduce
+
+1. List the steps to reproduce the bug.
+2. Be as detailed as possible to help with replication.
+
+#### Screenshots / Error Messages (if applicable)
+
+Insert any relevant screenshots or error messages related to the bug.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+#### Environment
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+- **Operating System**: [e.g., Windows 10, macOS, Linux]
+- **Browser (if applicable)**: [e.g., Google Chrome, Firefox, Safari]
+- **Application Version/Commit**: [e.g., v1.2.3, Git commit hash]
+- **Additional Environment Details**: [e.g., hardware specifications, network conditions]
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Additional Context
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+Provide any additional context or information about the bug.
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+### Possible Fix
 
-**Additional context**
-Add any other context about the problem here.
+If you have suggestions for a fix, please describe them here.

.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint
+        name: Markdownlint
+        files: \.(md|mdown|markdown)$
+        args: [
+            "--disable=MD013", # line-length
+            "--disable=MD033", # no-inline-html
+          ]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        name: codespell
+        description: Checks for common misspellings in text files
+        exclude: >
+          (?x)^(
+              .*\.json|
+          )$
+        args: ["-L", "gost,"] # ignore words
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]

README.md

@@ -2,10 +2,20 @@
 
 The MENA MTI team is preparing the Egypt Country Economic Memorandum (CEM) and other reports that monitor trends in the Egyptian economy. This repository includes an exploration of alternative data sources that could support analysis of Egypt's economic growth and demographics.
 
-## Data Availability Statement
+## Contributing
+
+We welcome contributions to improve this documentation. If you find errors, have suggestions, or want to add new content, please follow our [contribution guidelines](docs/CONTRIBUTING.md).
+
+### Feedback and Issues
+
+If you have any feedback, encounter issues, or want to suggest improvements, please [open an issue](https://github.com/datapartnership/gaza-israel-conflict-impact-analysis/issues/new/choosem).
+
+## Data
+
+### Data Availability Statement
 
 Restrictions may apply to the data that support the findings of this study. Data received from the private sector through the Development Data Partnership are subject to the terms and conditions of the data license agreement and the "Official Use Only" data classification. These data are available upon request through the [Development Data Partnership](https://datapartnership.org). Licensing and access information for all other datasets are included in the documentation.
 
 ## License
 
-The repository is licensed under the [Mozilla Public License](https://www.mozilla.org/en-US/MPL/).
+This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.

_static/custom.css

@@ -45,4 +45,4 @@ a.current.reference.internal {
 
 #pst-back-to-top {
 	background-color: #3eacad;
-}
+}

docs/CODE_OF_CONDUCT.md

@@ -114,15 +114,6 @@ the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0. Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

docs/_config.yml

@@ -2,7 +2,7 @@
 title:
 author: Development Data Group
 logo: docs/images/logo.png
-only_build_toc_files: true
+only_build_toc_files: false
 
 repository:
   url: https://github.com/datapartnership/egypt-economic-monitor
@@ -19,7 +19,10 @@ html:
   baseurl: https://datapartnership.github.io/egypt-economic-monitor
   extra_footer: |
     <div>
-      All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries. <b>All content (unless otherwise specified) is subject to the <a href="https://www.mozilla.org/en-US/MPL/">Mozilla Public License</a>.</b>
+     Country borders or names do not necessarily reflect the World Bank Group’s official position. All maps are for illustrative purposes and do not imply the expression of any opinion on the part of the World Bank, concerning the legal status of any country or territory or concerning the delimitation of frontiers or boundaries
+    </div>
+    <div>
+        <b>All content (unless otherwise specified) is subject to the <a href="https://www.mozilla.org/en-US/MPL">Mozilla Public License.</a></b>
     </div>
   favicon: docs/images/favicon.ico
 

docs/_toc.yml

@@ -4,10 +4,8 @@ root: README
 parts:
   - caption: Introduction to Data Goods
     chapters:
-      - file: docs/introduction_to_data_goods
-  - caption: Understanding Egypt's Economy through Alternative Data
-    chapters:
-      - file: docs/foundational_datasets_and_data_products
+      - file: docs/introduction-to-data-goods
+      - file: docs/data
   - caption: Data Products
     chapters:
       - file: notebooks/activity/business-activity-trends.ipynb

docs/business-trends.md

@@ -1,10 +1,9 @@
 # Analysing Business Activity Trends in Egypt
 
-[Business Activity Trends](https://dataforgood.facebook.com/dfg/tools/business-activity-trends#methodology) are a crisis-triggered dataset released by Meta. The dataset is relesed at a national level. [GADM shpefiles](https://gadm.org/) are slightly different from the official shapefiles used in this project from [HdX, UNOCHA](https://data.humdata.org/dataset/cod-ab-tur). COVID-19 triggered dataset is used in this analysis. 
+[Business Activity Trends](https://dataforgood.facebook.com/dfg/tools/business-activity-trends#methodology) are a crisis-triggered dataset released by Meta. The dataset is relesed at a national level. [GADM shpefiles](https://gadm.org/) are slightly different from the official shapefiles used in this project from [HdX, UNOCHA](https://data.humdata.org/dataset/cod-ab-tur). COVID-19 triggered dataset is used in this analysis.
 
-Business Activity Trends During Crisis uses data about posting activity on Facebook to measure how local businesses are affected by and recover from crisis events. Given the broad presence of small businesses on the Facebook platform, this dataset aims to provide timely estimates of global business activity without the common limitations of traditional data collection methods, such as scale, speed and nonstandardization. This is a crisis-triggered dataset i.e., it has been created by Meta to support humanitarian relief for post COVID in Egypt. Details about this dataset can be found on [Meta's Data For Good page](https://dataforgood.facebook.com/dfg/tools/business-activity-trends). 
+Business Activity Trends During Crisis uses data about posting activity on Facebook to measure how local businesses are affected by and recover from crisis events. Given the broad presence of small businesses on the Facebook platform, this dataset aims to provide timely estimates of global business activity without the common limitations of traditional data collection methods, such as scale, speed and nonstandardization. This is a crisis-triggered dataset i.e., it has been created by Meta to support humanitarian relief for post COVID in Egypt. Details about this dataset can be found on [Meta's Data For Good page](https://dataforgood.facebook.com/dfg/tools/business-activity-trends).
 
-The Business Activity Trends dataset was provided by [Meta](https://dataforgood.facebook.com/dfg/tools/business-activity-trends) through the proposal [Egypt Country Economic Monitor](https://portal.datapartnership.org/readableproposal/427) of the [Development Data Partnership](https://datapartnership.org). The data consisted of daily business activity quantile information at a GADM 2 level broken down by business vertical. Each cell (row) of the dataset contains data on the daily activity within a polygon-vertical combination. 
+The Business Activity Trends dataset was provided by [Meta](https://dataforgood.facebook.com/dfg/tools/business-activity-trends) through the proposal [Egypt Country Economic Monitor](https://portal.datapartnership.org/readableproposal/427) of the [Development Data Partnership](https://datapartnership.org). The data consisted of daily business activity quantile information at a GADM 2 level broken down by business vertical. Each cell (row) of the dataset contains data on the daily activity within a polygon-vertical combination.
 
 **The COVID-19 triggered Business Activity Trends dataset contains daily data from March 1, 2020 to Nov 29, 2022 at the national level. Activity quantile is used to measure the business activity trends in this dataset.**
-

docs/foundational_datasets_and_data_products.md → docs/data.md

@@ -1,6 +1,6 @@
-# Foundational Datasets, Data Products, & Sample Indicators
+# Datasets, Data Products, & Sample Indicators
 
-## Foundational Datasets
+## Datasets
 
 **Foundational Datasets** refer to **all** datasets used in the analytics prepared for a project. The Foundational Datasets table includes a description of the data and their update frequency, as well as access links and contact information for questions about use and access. Users should not require any datasets not included in this table to complete the analytical work for the Data Good.