Update CONTRIBUTING.md

README.md

@@ -2,19 +2,16 @@
 
 > Using Alternative Data to Understand Economic Impacts of the 2023 Gaza-Israel Conflict
 
-### Data Goods
+The 2023 Gaza-Israel Conflict had profound economic implications that extend beyond conventional measures. This project aims to explore alternative data sources, such as synthetic-aperture radar and nighttime lights, to better comprehend the multifaceted economic impacts on the Gaza Strip. Leveraging alternative data sources can provide a more nuanced understanding of the economic landscape during and after such events, when traditional economic indicators may not fully capture the complex dynamics and localized effects of conflicts.
 
-Datasets and methods used to generate insights for this project have been prepared as **Data Goods**. Data Goods are comprised of data, reproducible methods (code), documentation, and sample insights. Unlike a traditional data analysis, which results in a single-use report or visualization, Data Goods are designed to be re-used for future updates and projects, thereby building the capacity of the World Bank and partner organizations to quickly and effectively deliver complex data science solutions to pressing global challenges.
-
-## Contents
+## Contributing
 
-```{tableofcontents}
-```
+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).
 
-## Contributing
+### Feedback and Issues
 
-Contributions are welcome! If you’d like to contribute, please follow our [contribution guidelines](docs/CONTRIBUTING).
+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).
 
 ## License
 
-The repository is licensed under the [**Mozilla Public License**](LICENSE).
+This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.

docs/CONTRIBUTING.md

@@ -1,26 +1,84 @@
 # CONTRIBUTING
 
-Thank you for considering contributing! We appreciate your interest in helping us improve our project. By contributing, you agree to abide by our [Code of Conduct](docs/CODE_OF_CONDUCT.md).
+Thank you for considering contributing to this project! Your involvement helps improve the overall quality and functionality of the project and its codebase. Please take a moment to review the following guidelines to ensure a collaborative contribution process.
 
-Please take a moment to review this document for important information on how to contribute effectively.
+## Code of Conduct
+
+Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md) in place. We expect all contributors to adhere to it, both in interactions within this project and in interactions with other project members to promote a welcoming and inclusive environment for everyone.
 
 ## How Can I Contribute?
 
 There are several ways you can contribute to this project:
 
-- **Bug Reports:** If you encounter a bug or unexpected behavior, please open an issue on our GitHub issue tracker. Be sure to include as much detail as possible to help us identify and fix the problem.
+- **🐞 Bug Reports:** If you encounter a bug or unexpected behavior, please open an issue on GitHub. Be sure to include as much detail as possible to help us identify and fix the problem.
+
+- **✨ Feature Requests**: If you have an idea for a new feature or enhancement, please open an issue on GitHub. Describe the feature and its use case in detail.
+
+- **🏗️ Pull Requests (PR):** If you'd like to contribute code or documentation changes, we encourage you to submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+
+- **📖 Documentation:** If you find any errors or have suggestions for improving our documentation, you can submit changes directly through a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+
+- **📣 Community Engagement:** Pose questions, help othe contributors and engage with the community on our [Discussions](https://github.com/orgs/worldbank/discussions).
+
+## Contributing to the Code and Documentation
+
+Whether you are novice and expert, your contribution is valuable. If you're contributing code, we recommend getting started with [GitHub Guides](https://github.com/git-guides), [GitHub Skills](https://skills.github.com/), [GitHub Desktop](https://desktop.github.com) and/or [GitHub Docs](https://docs.github.com/en/get-started). In special, see also [collaborating with pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests). When ready, you may follow these guidelines:
+
+1. **[Fork the Repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)**: Click the "Fork" button on the top-right corner of this repository on GitHub. This will create a copy of the project in your GitHub account. Then, clone or download this repository to your local machine. Then, navigate to the root directory of the repository.
+
+2. **[Create a Branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository):** Create a new branch for your feature or bug fix. Use a clear and descriptive name for your branch, like `feature/new-feature`.
+
+3. **Code Review and Changes:** Make your code changes and ensure they adhere to our coding standards.
+
+4. **Test:** Ensure that your changes do not break existing functionality.
+
+5. **[Commit and Push](https://github.com/git-guides/git-commit):** Commit your changes with a clear and concise commit message. Reference any related issues or pull requests in your commit message. Push your branch to your forked repository on GitHub.
+
+6. **[Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):** Open a pull request against the main branch of this repository. Provide a clear description of your changes and reference any relevant issues. Your PR will be reviewed by maintainers.
 
-- **Feature Requests**: If you have an idea for a new feature or enhancement, please open an issue on our GitHub issue tracker and label it as a "feature request." Describe the feature and its use case in detail.
+7. **[Review and Iterate](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review):** Expect feedback and be prepared to make additional changes if necessary. We may request changes, and once everything looks good, your PR will be merged.
 
-- **Pull Requests:** If you'd like to contribute code or documentation changes, we encourage you to submit a pull request (PR). Please follow the guidelines outlined in the [Contributing Code](CONTRIBUTING.md) section below.
+### Running Notebooks Locally
 
-- **Documentation:** If you find any errors or have suggestions for improving our documentation, you can submit changes directly through a pull request.
+This repository provides a Conda/Mamba environment configuration to ensure consistent dependencies across different environments. [Conda](https://docs.conda.io)/[Mamba](https://mamba.readthedocs.io) are prevalent (interoperable) package managers. If haven't installed either, you may follow the installation instructions on the respective documentation.
 
-- **Community Engagement:** Help answer questions and engage with other users and contributors on our GitHub Discussions (if applicable).
+To run the notebooks locally, after (1) and (2) above, please follow these steps:
+
+- Create (or update) the environment:
+
+ ```shell
+ mamba env create -f notebooks/environment.yml
+ ```
+
+ This command will create a new environment based on the specifications provided in the `environment.yml` file.
+
+- [Activate the environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment), run [JupyterLab](https://jupyterlab.readthedocs.io) and execute `notebooks`:
+
+ ```shell
+ jupyterlab
+ ```
+
+### Building Documentation Locally
+
+To build the documentation locally, after (1) and (2) above, please follow these steps:
+
+- Install the documentation dependencies:
+
+ ```shell
+ pip install -r docs/requirements/xt
+ ```
+
+- Build the documentation:
+
+ ```shell
+ jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml
+ ```
+
+The generated documentation will be available in the `_build/html` directory. Open the `index.html` file in a web browser to view it.
 
 ## Contributing Code
 
-If you're contributing code, please follow these guidelines:
+Whether you are novice and expert, your contribution is valuable. If you're contributing code, please follow these guidelines:
 
 1. **Fork the Repository**: Click the "Fork" button on the top-right corner of this repository on GitHub. This will create a copy of the project in your GitHub account.
 
@@ -36,10 +94,6 @@ If you're contributing code, please follow these guidelines:
 
 7. **Review and Iterate:** Expect feedback and be prepared to make additional changes if necessary. We may request changes, and once everything looks good, your PR will be merged.
 
-## Code of Conduct
-
-Please note that we have a [Code of Conduct](docs/CODE_OF_CONDUCT) in place. We expect all contributors to adhere to it, both in interactions within this project and in interactions with other project members.
-
 ## Licensing
 
 By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

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/gaza-israel-conflict-impact-analysis

docs/_toc.yml

@@ -4,7 +4,7 @@ root: README
 parts:
  - caption: Introduction to Data Goods
  chapters:
- - file: docs/introduction_to_data_goods
+ - file: docs/introduction-to-data-goods
  - file: docs/data
  - caption: Data Products
  chapters:

docs/introduction-to-data-goods.md

@@ -1,4 +1,4 @@
-# Introduction to Data Goods
+# What's a Data Good?
 
 **Data Goods** are comprised of data, reproducible methods (code), documentation, and sample insights. Unlike a traditional data analysis, which results in a single-use report or visualization, Data Goods are designed to be re-used for future updates and projects, thereby building the capacity of the World Bank and partner organizations to quickly and effectively deliver complex data science solutions to pressing global challenges.
 

notebooks/environment.yml

@@ -1,7 +1,14 @@
+name: datapartnership-gaza-israel-conflict-impact-analysis
 channels:
  - conda-forge
- - defaults
 dependencies:
  - python=3.10
- - bokeh=2.4.3
- - pandas=1.4.3
+ - bokeh
+ - colorcet
+ - folium
+ - geopandas
+ - jupyterlab
+ - pandas
+ - pip
+ - pip:
+ - blackmarblepy