Updates on files

Author: Alexander Rogalskiy

Makefile

@@ -36,6 +36,12 @@ else
 	AT := @
 endif
 
+# Optional flag to run target in a docker container.
+# (example `make test USE_DOCKER=true`)
+ifeq ($(USE_DOCKER),true)
+	DOCKER_CMD := docker compose run
+endif
+
 IMAGE ?= styled-java-patterns
 OKTETO_IMAGE ?= okteto/$(IMAGE)
 DOCKER_IMAGE ?= alexanderr/$(IMAGE)
@@ -82,12 +88,23 @@ _venv:
 	@echo -e "$(cred)Virtual env created. The source pages are in $(VENV_NAME) directory.$(cend)"
 	@echo
 
+# This rule creates a file named .env that is used by docker-compose for passing
+# the USER_ID and GROUP_ID arguments to the Docker image.
+.env: ## Setup step for using using docker-compose with make target.
+	@touch .env
+ifneq ($(OS),Windows_NT)
+ifneq ($(shell uname -s), Darwin)
+	@echo USER_ID=$(shell id -u) >> .env
+	@echo GROUP_ID=$(shell id -g) >> .env
+endif
+endif
+
 # Create help information.
 .PHONY: help
 help:
 	@echo
 	@echo
-	@echo -e "$(cred)Please use [make <target>] where <target> is one of:$(cend)"
+	@echo -e "$(cred)Please use <make [target] [USE_DOCKER=true]> where [target] is one of:$(cend)"
 	@echo "  all       				to run linting & format tasks"
 	@echo "  clean     				to remove temporary directories"
 	@echo "  deps 						to install dependencies"
@@ -113,6 +130,7 @@ help:
 	@echo "  venv-run  				to run documentation in virtual environment"
 	@echo "  versions  				to list commands versions"
 	@echo
+	@echo 'use USE_DOCKER=true to run target in a docker container'
 	@echo
 
 # Lists all targets defined in this makefile.

crowdin.yml

@@ -0,0 +1,7 @@
+commit_message: "docs(i18n): New translations %original_file_name% (%language%)"
+append_commit_message: false
+files:
+  - source: /docs/**/*.md
+    translation: /docs/**/%file_name%.%two_letters_code%.%file_extension%
+    ignore:
+      - /docs/**/%file_name%.%two_letters_code%.%file_extension%

docs/requirements.txt

@@ -11,6 +11,7 @@ python-markdown-math>=0.6
 mkdocs-material-extensions>=1.0
 mkdocs-git-revision-date-localized-plugin>=0.9.2
 mkdocs-awesome-pages-plugin>=2.5.0
+mkdocs-static-i18n>=0.14
 mdx-truly-sane-lists>=1.2
 mkdocs-include-markdown-plugin>=3.2.1
 mkdocs-redirects>=1.0.3

mkdocs.yml

@@ -34,6 +34,7 @@ theme:
     - navigation.tracking
     - navigation.sections
     - navigation.expand
+    - navigation.instant
     - navigation.indexes
     - search.suggest
     - search.highlight
@@ -62,6 +63,12 @@ theme:
 # Plugins
 plugins:
   - search
+  - i18n:
+      default_language: en
+      languages:
+        en: English
+        uk: Українська
+        zh: 简体中文
   - git-revision-date-localized: # https://squidfunk.github.io/mkdocs-material/plugins/revision-date/
       fallback_to_build_date: true
       type: date