Merge branch 'main' of github.com:HTTPArchive/almanac.httparchive.org into production

Author: tunetheweb

.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+{
+    "name": "Dev Container",
+    "build": {
+        "dockerfile": "../src/Dockerfile",
+        "target": "base",
+        "context": "../",
+        "args": {
+            "SKIPGC": "false"
+        }
+    },
+    "forwardPorts": [
+        8080
+    ],
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python",
+                "python.linting.enabled": true,
+                "python.linting.pylintEnabled": true
+            },
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance"
+            ]
+        },
+        "codespaces": {
+            "openFiles": [
+                "src/README.md"
+            ]
+        }
+    },
+    "onCreateCommand": "cd src && pip install -r requirements.txt && npm install"
+}

.github/lighthouse/lighthouse-config-dev.json

@@ -7,10 +7,12 @@
         "bootup-time": "off",
         "canonical": "off",
         "dom-size": "off",
+        "efficient-animated-content": "off",
         "first-contentful-paint": "off",
         "first-cpu-idle": "off",
         "first-meaningful-paint": "off",
         "font-display": "off",
+        "th-has-data-cells": "off",
         "inspector-issues": "off",
         "installable-manifest": "off",
         "interactive": "off",

.github/lighthouse/lighthouse-config-prod.json

@@ -9,10 +9,12 @@
         "bf-cache": "off",
         "bootup-time": "off",
         "dom-size": "off",
+        "efficient-animated-content": "off",
         "first-contentful-paint": "off",
         "first-cpu-idle": "off",
         "first-meaningful-paint": "off",
         "font-display": "off",
+        "th-has-data-cells": "off",
         "inspector-issues": "off",
         "installable-manifest": "off",
         "interactive": "off",

.github/workflows/code-static-analysis.yml

@@ -35,7 +35,7 @@ jobs:
         uses: actions/checkout@v3
       - name: Set up Python 3.8
         if: ${{ matrix.language == 'python' }}
-        uses: actions/setup-python@v4.6.0
+        uses: actions/setup-python@v4.6.1
         with:
           python-version: '3.8'
       - name: Install dependencies

.github/workflows/lintsql.yml

@@ -19,7 +19,7 @@ jobs:
           # Full git history is needed to get a proper list of changed files within `super-linter`
           fetch-depth: 0
       - name: Set up Python 3.8
-        uses: actions/setup-python@v4.6.0
+        uses: actions/setup-python@v4.6.1
         with:
           python-version: '3.8'
       - name: Lint SQL code

.github/workflows/predeploy.yml

@@ -37,7 +37,7 @@ jobs:
       with:
         node-version: '16'
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4.6.0
+      uses: actions/setup-python@v4.6.1
       with:
         python-version: '3.8'
     - name: Install Asian Fonts

.github/workflows/test_website.yml

@@ -30,7 +30,7 @@ jobs:
       with:
         node-version: '16'
     - name: Set up Python 3.8
-      uses: actions/setup-python@v4.6.0
+      uses: actions/setup-python@v4.6.1
       with:
         python-version: '3.8'
     - name: Run the website

README.md

@@ -1,8 +1,8 @@
 # 📕 Web Almanac
 
-[![Production Checks GitHub Action](https://github.com/HTTPArchive/almanac.httparchive.org/workflows/Production%20Checks/badge.svg)](https://github.com/HTTPArchive/almanac.httparchive.org/actions?query=workflow%3A%22Production+Checks%22) [![Test Website GitHub Action](https://github.com/HTTPArchive/almanac.httparchive.org/workflows/Test%20Website/badge.svg?branch=main)](https://github.com/HTTPArchive/almanac.httparchive.org/actions?query=workflow%3A%22Test+Website%22) [![Security Headers Rating](https://img.shields.io/security-headers?url=https%3A%2F%2Falmanac.httparchive.org%2Fen%2F2019%2F)](https://securityheaders.com/?q=https%3A%2F%2Falmanac.httparchive.org%2Fen%2F2019%2F&followRedirects=on) [![TLS Observatory](https://img.shields.io/mozilla-observatory/grade-score/almanac.httparchive.org?publish)](https://observatory.mozilla.org/analyze/almanac.httparchive.org)
+[![Production Checks GitHub Action](https://github.com/HTTPArchive/almanac.httparchive.org/workflows/Production%20Checks/badge.svg)](https://github.com/HTTPArchive/almanac.httparchive.org/actions?query=workflow%3A%22Production+Checks%22) [![Test Website GitHub Action](https://github.com/HTTPArchive/almanac.httparchive.org/workflows/Test%20Website/badge.svg?branch=main)](https://github.com/HTTPArchive/almanac.httparchive.org/actions?query=workflow%3A%22Test+Website%22) [![TLS Observatory](https://img.shields.io/mozilla-observatory/grade-score/almanac.httparchive.org?publish)](https://observatory.mozilla.org/analyze/almanac.httparchive.org)
 
-[![2022 Content Planning](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/20)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/20) [![2022 Analysis Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/21)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/21) [![2022 Content Writing Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/22)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/22) [![2022 Launch!](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/23)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/23) [![2021 Content Translation Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/19)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/19)
+[![2022 Content Planning](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/20)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/20) [![2022 Analysis Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/21)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/21) [![2022 Content Writing Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/22)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/22) [![2022 Launch!](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/23)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/23) [![Content Translation Milestone](https://img.shields.io/github/milestones/progress/HttpArchive/almanac.httparchive.org/19)](https://github.com/HTTPArchive/almanac.httparchive.org/milestone/19)
 
 [![Open Dev Pull Requests](https://img.shields.io/github/issues-pr/HTTPArchive/almanac.httparchive.org/development)](https://github.com/HTTPArchive/almanac.httparchive.org/pulls?q=is%3Apr+is%3Aopen+label%3Adevelopment) [![Open Analysis Pull Requests](https://img.shields.io/github/issues-pr/HTTPArchive/almanac.httparchive.org/analysis)](https://github.com/HTTPArchive/almanac.httparchive.org/pulls?q=is%3Apr+is%3Aopen+label%3Aanalysis) [![Open Translation Pull Requests](https://img.shields.io/github/issues-pr/HTTPArchive/almanac.httparchive.org/translation)](https://github.com/HTTPArchive/almanac.httparchive.org/pulls?q=is%3Apr+is%3Aopen+label%3Atranslation) [![Open Writing Pull Requests](https://img.shields.io/github/issues-pr/HTTPArchive/almanac.httparchive.org/writing)](https://github.com/HTTPArchive/almanac.httparchive.org/pulls?q=is%3Apr+is%3Aopen+label%3Awriting)
 
@@ -28,14 +28,11 @@ The Web Almanac is available in the original [English](https://almanac.httparchi
 
 See [our contributing guide](CONTRIBUTING.md). To run the Web Almanac locally please see [src/README.md](src/README.md).
 
-## 2022 Timeline
+## Next Web Almanac timeline
 
-- April: forming teams
-- May: forming teams / planning content
-- June: HTTP Archive crawl / analysis
-- August: analysis / writing
-- September: analysis / writing
-- End of September: launch!
+We are [taking a break for 2023](https://github.com/HTTPArchive/almanac.httparchive.org/discussions/33610), but hope to return in future.
+
+In the meantime, enjoy the [2022 edition](https://almanac.httparchive.org) and we're still open to contributions in the form of [translations](https://github.com/HTTPArchive/almanac.httparchive.org/issues?q=is%3Aissue+is%3Aopen+label%3Atranslation), [development](https://github.com/HTTPArchive/almanac.httparchive.org/issues?q=is%3Aissue+is%3Aopen+label%3Adevelopment) or bug fixes.
 
 ## Where to find us
 

src/Dockerfile

@@ -1,22 +1,22 @@
 ARG     PYVER=3.8
-FROM    python:${PYVER}
+FROM    python:${PYVER} as base
 
 # Enable unbuffered STDOUT logging
 ENV     PYTHONUNBUFFERED=1
 
-ARG     NODEVER=12.x
+ARG     NODEVER=16.x
 RUN     curl -sL https://deb.nodesource.com/setup_${NODEVER} | bash -
 
-RUN     apt update && apt install -y \
-          nodejs \
-        && rm -rf /var/lib/apt/lists/*
+RUN     apt update && apt install -y nodejs && rm -rf /var/lib/apt/lists/* \
+        && /usr/local/bin/python -m pip install --upgrade pip
 
 # Add Google Cloud SDK only if image is built with `--build-arg SKIPGC=false`
 ARG     SKIPGC=true
 RUN     $SKIPGC || (echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" > /etc/apt/sources.list.d/google-cloud-sdk.list \
         && curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key --keyring /usr/share/keyrings/cloud.google.gpg add - \
         && apt update && apt install -y google-cloud-sdk && rm -rf /var/lib/apt/lists/*)
 
+FROM base
 WORKDIR /app
 COPY    requirements.txt package*.json ./
 RUN     pip install -r requirements.txt

src/README.md

@@ -1,6 +1,8 @@
 # Developing the Web Almanac
 
-The Web Almanac can be developed on macOS, Windows or Linux. It requires Node v12, Python v3.8 and pip to be installed. Alternatively, use Docker to avoid manually configuring the development environment.
+The Web Almanac can be developed on macOS, Windows or Linux. It requires Node v16, Python v3.8 and pip to be installed. You can use Docker to avoid manually configuring the development environment.
+It can be quickly deployed as a development container in GitHub Codespaces to develop in cloud:
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/HTTPArchive/almanac.httparchive.org?quickstart=1)
 
 ## Style guide
 
@@ -12,7 +14,7 @@ An `.editorconfig` file exists for those using [EditorConfig](https://editorconf
 
 Make sure you run the following commands from within the `src` directory by executing `cd src` first.
 
-Make sure Python (3.8 or above), pip and NodeJS (v12 or above) are installed on your machine.
+Make sure Python (3.8 or above), pip and NodeJS (v16 or above) are installed on your machine.
 
 1. If you don't have virtualenv, install it using pip.
 
@@ -411,7 +413,6 @@ docker container run --rm -it -v "$PWD":/app webalmanac npm run pytest
 ```
 docker container run --rm -it -v "$PWD":/app -v /app/node_modules -p 8080:8080 webalmanac bash
 root@[CID]:/app# python main.py
-^C
 root@[CID]:/app# npm run generate
 root@[CID]:/app# npm run pytest
 root@[CID]:/app# exit
@@ -428,11 +429,11 @@ docker image build --build-arg PYVER=3.8 --build-arg NODEVER=14.x --build-arg SK
 This will depend on your operating system but for MacOS/Linux this would be:
 
 ```
-docker container run -it --rm -v /app/node_modules -v "$PWD/..":/app -w /app/src --entrypoint=./tools/scripts/run_linter_locally.sh github/super-linter
+docker container run -it --rm -v /app/node_modules -v "$PWD/..":/app -w /app/src --entrypoint=./tools/scripts/run_linter_locally.sh github/super-linter:slim-latest
 ```
 
 And for Windows:
 
 ```
-docker container run --rm -v /app/node_modules -v %cd%\\..:/app -w /app/src --entrypoint=./tools/scripts/run_linter_locally.sh github/super-linter
+docker container run --rm -v /app/node_modules -v %cd%\\..:/app -w /app/src --entrypoint=./tools/scripts/run_linter_locally.sh github/super-linter:slim-latest
 ```