From d60233cdd3beb4e5c67199069fe72dba78147c85 Mon Sep 17 00:00:00 2001 From: "sarahmccarthy123@yahoo.com" Date: Sat, 29 Jun 2024 09:14:01 +0200 Subject: [PATCH] [TASK] Add missing files to render update --- .editorconfig | 4 ++++ .github/workflows/documentation.yml | 17 +++++++++++++++++ Documentation/guides.xml | 15 +++++++++++++++ Makefile | 16 ++++++++++++++++ 4 files changed, 52 insertions(+) create mode 100644 .github/workflows/documentation.yml create mode 100644 Documentation/guides.xml create mode 100644 Makefile diff --git a/.editorconfig b/.editorconfig index 25e24d9..d9d7546 100644 --- a/.editorconfig +++ b/.editorconfig @@ -23,3 +23,7 @@ trim_trailing_whitespace = true indent_style = space indent_size = 4 max_line_length = 80 + +[{Makefile,**.mk}] +# Use tabs for indentation (Makefiles require tabs) +indent_style = tab \ No newline at end of file diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..3076117 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,17 @@ +name: Test documentation + +on: [ push, pull_request ] + +jobs: + tests: + name: Render documentation + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Test if the documentation will render without warnings + run: | + mkdir -p Documentation-GENERATED-temp \ + && docker run --rm --pull always -v $(pwd):/project \ + ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 0000000..3529437 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..35ecee1 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +.PHONY: help +help: ## Displays this list of targets with descriptions + @echo "The following commands are available:\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' + + +.PHONY: docs +docs: ## Generate projects docs (from "Documentation" directory) + mkdir -p Documentation-GENERATED-temp + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation + + +.PHONY: test-docs +test-docs: ## Test the documentation rendering + mkdir -p Documentation-GENERATED-temp + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log