Merge pull request wodby#369 from irmantasp/master

Implement Self-Documenting Makefiles

Author: csandanov

docker.mk

@@ -6,30 +6,46 @@ default: up
 
 DRUPAL_ROOT ?= /var/www/html/web
 
+## help	:	Print commands help.
+help : docker.mk
+	@sed -n 's/^##//p' $<
+
+## up	:	Start up containers.
 up:
 	@echo "Starting up containers for $(PROJECT_NAME)..."
 	docker-compose pull
 	docker-compose up -d --remove-orphans
 
+## down	:	Stop containers.
 down: stop
 
+## stop	:	Stop containers.
 stop:
 	@echo "Stopping containers for $(PROJECT_NAME)..."
 	@docker-compose stop
 
+## prune	:	Remove containers and their volumes.
 prune:
 	@echo "Removing containers for $(PROJECT_NAME)..."
 	@docker-compose down -v
 
+## ps	:	List running containers.
 ps:
 	@docker ps --filter name='$(PROJECT_NAME)*'
 
+## shell	:	Access `php` container via shell.
 shell:
 	docker exec -ti -e COLUMNS=$(shell tput cols) -e LINES=$(shell tput lines) $(shell docker ps --filter name='$(PROJECT_NAME)_php' --format "{{ .ID }}") sh
 
+## drush	:	Executes `drush` command in a specified `DRUPAL_ROOT` directory (default is `/var/www/html/web`).
+## 		Doesn't support --flag arguments.
 drush:
 	docker exec $(shell docker ps --filter name='^/$(PROJECT_NAME)_php' --format "{{ .ID }}") drush -r $(DRUPAL_ROOT) $(filter-out $@,$(MAKECMDGOALS))
 
+## logs	:	View containers logs.
+##		You can optinally pass an argument with the service name to limit logs
+##		logs php	: View `php` container logs.
+##		logs nginx php	: View `nginx` and `php` containers logs.
 logs:
 	@docker-compose logs -f $(filter-out $@,$(MAKECMDGOALS))