Built site for gh-pages

.github/pull_request_template.md

@@ -0,0 +1,44 @@
+# Pull Request Summary 🚀
+
+## What does this PR do? 📝
+
+<!-- A clear and concise description of the changes introduced in this pull request -->
+
+## Why is this change needed? 🤔
+
+<!-- Describe the motivation or context for this pull request -->
+
+## How was this implemented? 🛠️
+
+<!-- Explain the approach and implementation details -->
+
+## How to test or reproduce ? 🧪
+
+<!-- Provide steps to test or reproduce the changes -->
+
+## Screenshots (if applicable) 📷
+
+<!-- Add relevant screenshots or GIFs to illustrate the changes -->
+
+## Checklist ✅
+
+- [ ] I have run and tested my changes locally
+- [ ] I have limit this PR to less than 1000 lines of code change (if not, explain why)
+- [ ] I have updated/added tests to cover my changes (if applicable)
+- [ ] I have updated/added requirements to cover my changes (if applicable)
+- [ ] I have run linting and formatting on any code changes (if applicable)
+- [ ] I have updated the documentation (README, etc.) accordingly
+- [ ] I have reviewed and resolved any merge conflict
+
+## Reviewer Emoji Legend
+
+|     |         `:code:`          | Meaning                                                                                                                                                                                                                                         |
+| :-: | :-----------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 😃👍💯 | `:smiley:` `:+1:` `:100:` | I like this... <br /><br /> ...and I want the author to know it! This is a way to highlight positive parts of a code review.                                                                                                                    |
+| ⭐⭐⭐ |  `:star: :star: :star:`   | Important to fix before PR can be approved... <br /><br /> And I am providing reasons why it needs to be addressed as well as suggested improvements.                                                                                           |
+| ⭐⭐  |      `:star: :star:`      | Important to fix but non-blocking for PR approval... <br /><br /> And I am providing suggestions where it could be improved either in this PR or later.                                                                                         |
+|  ⭐  |         `:star:`          | Give this some thought but non-blocking for PR approval... <br /><br /> ...and consider this a suggestion, not a requirement.                                                                                                                   |
+|  ❓  |       `:question:`        | I have a question. <br /><br /> This should be a fully formed question with sufficient information and context that requires a response.                                                                                                        |
+|  📝  |         `:memo:`          | This is an explanatory note, fun fact, or relevant commentary that does not require any action.                                                                                                                                                 |
+|  ⛏  |         `:pick:`          | This is a nitpick. <br /><br /> This does not require any changes and is often better left unsaid. This may include stylistic, formatting, or organization suggestions and should likely be prevented/enforced by linting if they really matter |
+| ♻️  |        `:recycle:`        | Suggestion for refactoring. <br /><br /> Should include enough context to be actionable and not be considered a nitpick.                                                                                                                        |

.nojekyll

@@ -0,0 +1 @@
+e95cb5f1

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+        stages: [commit]
+      - id: check-json
+        stages: [commit]
+      - id: check-toml
+        stages: [commit]
+      - id: check-merge-conflict
+        stages: [commit]
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.18
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.41.0
+    hooks:
+      - id: markdownlint-fix
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.8
+    hooks:
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        types_or: [python, pyi, jupyter]
+        require_serial: true
+
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.22.0
+    hooks:
+      - id: typos

_quarto.yml

@@ -0,0 +1,81 @@
+project:
+  type: website
+  preview:
+    port: 3434
+    browser: true
+execute:
+  freeze: auto
+website:
+  title: "Data and Tech Handbook"
+  description:  "Handbook for common, shared practices for data science and engineering at Innovations for Poverty Action."
+  favicon: ./docs/assets/images/IPA-primary-full-color-abbreviated.png
+  repo-url: https://github.com/PovertyAction/dse_handbook
+  repo-actions: [edit, issue]
+  bread-crumbs: false
+  reader-mode: true
+  search:
+    location: navbar
+    type: overlay
+  navbar:
+    background: '#155240'
+    foreground: '#ffffff'
+    logo: ./docs/assets/images/IPA-primary-white-abbreviated.png
+    collapse: true
+    right:
+      - href: ./docs/index.md
+        text: Home
+
+      - text: Guides
+        menu:
+        - href: ./docs/guides/computer_setup.md
+          text: Computer Setup
+        - href: ./docs/guides/venv.md
+          text: Virtual Environments
+        - href: ./docs/guides/code_review.md
+          text: Code Review
+        - href: ./docs/guides/pre_commit_hooks.md
+          text: pre-commit
+
+      - text: Software
+        menu:
+          - href: ./docs/software/git.md
+            text: Git
+          - href: ./docs/software/github.md
+            text: GitHub
+          - href: ./docs/software/vscode.md
+            text: VS Code
+          - href: ./docs/software/quarto.qmd
+            text: Quarto
+          - href: ./docs/software/python.qmd
+            text: Python
+          - href: ./docs/software/stata.qmd
+            text: Stata
+          - href: ./docs/software/sql.qmd
+            text: SQL
+
+      - text: Methods
+        menu:
+          - href: ./docs/methods/references.md
+            text: References
+
+      - text: Teams
+        menu:
+          - href: ./docs/teams/dse.md
+            text: DSE
+          - href: ./docs/teams/grds.md
+            text: GRDS
+          - href: ./docs/teams/mist.md
+            text: MIST
+          - href: ./docs/teams/ppi.md
+            text: PPI
+
+      - href: ./docs/contributing.md
+        text: Contributing
+
+format:
+  html:
+    # for sharepoint: use aspx
+    # reference: https://github.com/quarto-dev/quarto-cli/discussions/3535#discussioncomment-9111419
+    output-ext: html
+    css: ./docs/assets/style_ipa.css
+    toc: true