From 5314d48bb3fb6bea7f8eedb639bda8720c7bb940 Mon Sep 17 00:00:00 2001
From: Tom Kralidis <tomkralidis@gmail.com>
Date: Mon, 6 Oct 2025 21:03:38 -0400
Subject: [PATCH] add translation workflow to README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 28d175c2..fabd182c 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,26 @@ mkdocs build
 mkdocs serve  # website is made available on http://localhost:8000
 ```
 
+### Translating the workshop to a different language
+
+The workshop is setup to support content in different languages, via the [mkdocs-static-i18n](https://pypi.org/project/mkdocs-static-i18n) plugin. To add an additional language to the workshop:
+
+- in `mkdocs.yml`, section `plugins.i18n.languages`, add a section with at least the `locale`, `name`, and `build` directives.  For example, to add Greek:
+
+```yaml
+- locale: el
+  name: Ελληνικά
+  build: true
+```
+
+- foreach `.md` page in `workshop/content/docs`, add an equivalant page in the language with the locale code as part of the filename.  For example:
+  - `ogcapi-records.md` -> `ogcapi-records.el.md`
+
+- commit to your fork and issue a GitHub Pull Request
+
+NOTE: see [issue 217](https://github.com/geopython/diving-into-pygeoapi/issues/217) to track the implementation of auto-translation.
+
+
 ## Contributing updates
 
 To make contributions back to the workshop, fork the repository from GitHub.  Contributions and Pull Requests are always welcome!