Examples README (#738)

* add examples/README.md, update pmms and python examples titles * Apply suggestions from code review Co-authored-by: Philippe Rivière <[email protected]> * update deploy.yml with new project names --------- Co-authored-by: Allison Horst <[email protected]> Co-authored-by: Philippe Rivière <[email protected]>
observablehq · Feb 9, 2024 · a9a12cc · a9a12cc
1 parent f52bc22
commit a9a12cc
Show file tree

Hide file tree

Showing 14 changed files with 32 additions and 18 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -24,41 +24,41 @@ jobs:
             'examples/*/yarn.lock'
       - run: yarn --frozen-lockfile
       - run: yarn build
+      - name: Build example "api"
+        run: yarn --frozen-lockfile && yarn build
+        working-directory: examples/api
       - name: Build example "chess"
         run: yarn --frozen-lockfile && yarn build
         working-directory: examples/chess
+      - name: Build example "eia"
+        run: yarn --frozen-lockfile && yarn build
+        working-directory: examples/eia
+        env:
+          EIA_KEY: ${{ secrets.EIA_KEY }}
       - name: Build example "google-analytics"
         run: yarn --frozen-lockfile && yarn build
         working-directory: examples/google-analytics
         env:
           GA_PROPERTY_ID: ${{ vars.GA_PROPERTY_ID }}
           GA_CLIENT_EMAIL: ${{ secrets.GA_CLIENT_EMAIL }}
           GA_PRIVATE_KEY: ${{ secrets.GA_PRIVATE_KEY }}
-      - name: Build example "eia"
-        run: yarn --frozen-lockfile && yarn build
-        working-directory: examples/eia
-        env:
-          EIA_KEY: ${{ secrets.EIA_KEY }}
       - name: Build example "hello-world"
         run: yarn --frozen-lockfile && yarn build
         working-directory: examples/hello-world
-      - name: Build example "plot"
-        run: yarn --frozen-lockfile && yarn build
-        working-directory: examples/plot
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Build example "pmms"
-        run: yarn --frozen-lockfile && yarn build
-        working-directory: examples/pmms
-      - name: Build example "api"
+      - name: Build example "mortgage-rates"
         run: yarn --frozen-lockfile && yarn build
-        working-directory: examples/api
-      - name: Build example "python"
+        working-directory: examples/mortgage-rates
+      - name: Build example "penguin-classification"
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
           yarn --frozen-lockfile && yarn build
-        working-directory: examples/python
+        working-directory: examples/penguin-classification
+      - name: Build example "plot"
+        run: yarn --frozen-lockfile && yarn build
+        working-directory: examples/plot
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - run: mkdir dist/examples && for i in examples/*; do if [ -d $i/dist ]; then mv -v $i/dist dist/examples/$(basename $i); fi; done
       - uses: cloudflare/pages-action@1
         with:

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,14 @@
+# Observable Framework examples
+
+*First:* [Get started with Observable Framework](https://observablehq.com/framework/getting-started)
+
+*This repository shows different flavors and features of what you can build with Framework:*
+
+- **API** — Millions of API requests, stored in Arrow format, are analyzed in a report. [[code](./api)] [[live project](https://observablehq.com/framework/examples/api/)]
+- **Chess** — A data loader that retrieves several large zip files from the FIDE, extracts information about the top 10 players, and displays a rank chart. [[code](./chess)] [[live project](https://observablehq.com/framework/examples/chess/)]
+- **EIA** — JavaScript data loaders retrieve hourly data from the U.S. Energy Information Administration API to produce a map and time series charts. [[code](./eia)] [[live project](https://observablehq.com/framework/examples/eia/)]
+- **Google analytics** — Load data from the G.A. API and analyze your website’s traffic. [[code](./google-analytics)] [[live project](https://observablehq.com/framework/examples/google-analytics/)]
+- **Hello, world!** — A minimal test. [[code](./hello-world)] [[live project](https://observablehq.com/framework/examples/hello-world/)]
+- **Plot** — TypeScript data loaders that access metadata from the Observable Plot Github repo. [[code](./plot)] [[live project](https://observablehq.com/framework/examples/plot/)]
+- **Mortgage rates** — A small dashboard reproducing Freddie Mac’s historic mortgage rates dashboard. [[code](./mortgage-rates)] [[live project](https://observablehq.com/framework/examples/mortgage-rates/)]
+- **Penguin classification** — In a Python data loader, we use logistic regression to predict penguin species based on body size measurements. [[code](./penguin-classification)] [[live project](https://observablehq.com/framework/examples/penguin-classification/)]
diff --git a/examples/pmms/.gitignore → examples/mortgage-rates/.gitignore b/examples/pmms/.gitignore → examples/mortgage-rates/.gitignore
diff --git a/examples/pmms/README.md → examples/mortgage-rates/README.md b/examples/pmms/README.md → examples/mortgage-rates/README.md
diff --git a/examples/pmms/docs/data/pmms.csv.ts → ...ples/mortgage-rates/docs/data/pmms.csv.ts b/examples/pmms/docs/data/pmms.csv.ts → ...ples/mortgage-rates/docs/data/pmms.csv.ts
diff --git a/examples/pmms/docs/index.md → examples/mortgage-rates/docs/index.md b/examples/pmms/docs/index.md → examples/mortgage-rates/docs/index.md
diff --git a/examples/pmms/package.json → examples/mortgage-rates/package.json b/examples/pmms/package.json → examples/mortgage-rates/package.json
diff --git a/examples/python/.gitignore → examples/penguin-classification/.gitignore b/examples/python/.gitignore → examples/penguin-classification/.gitignore
diff --git a/examples/python/README.md → examples/penguin-classification/README.md b/examples/python/README.md → examples/penguin-classification/README.md
diff --git a/examples/python/docs/data/penguins.csv → ...uin-classification/docs/data/penguins.csv b/examples/python/docs/data/penguins.csv → ...uin-classification/docs/data/penguins.csv
diff --git a/examples/python/docs/data/predictions.csv.py → ...assification/docs/data/predictions.csv.py b/examples/python/docs/data/predictions.csv.py → ...assification/docs/data/predictions.csv.py
diff --git a/examples/python/docs/index.md → ...ples/penguin-classification/docs/index.md b/examples/python/docs/index.md → ...ples/penguin-classification/docs/index.md
@@ -2,7 +2,7 @@
 toc: false
 ---
 
-# Classification prediction
+# Penguin classification
 
 ```js
 const predictions = FileAttachment("data/predictions.csv").csv({typed: true});

diff --git a/examples/python/package.json → examples/penguin-classification/package.json b/examples/python/package.json → examples/penguin-classification/package.json
diff --git a/examples/python/requirements.txt → ...s/penguin-classification/requirements.txt b/examples/python/requirements.txt → ...s/penguin-classification/requirements.txt