Skip to content

Commit

Permalink
[TASK] Add missing files to render update
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahmccarthy123 committed Jun 29, 2024
1 parent 80d78f3 commit d60233c
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -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
17 changes: 17 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" links-are-relative="true">
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" project-home="https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/" project-contact="https://typo3.slack.com/archives/C028JEPJL" project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors" project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors/issues" edit-on-github-branch="main" edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-Editors" typo3-core-preferred="stable" interlink-shortcode="typo3/tutorial-editors"/>
<project title="Tutorial for Editors" release="main (development)" version="main (development)" copyright="since 2012 by the TYPO3 contributors"/>
<inventory id="t3coreapi" url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/"/>
<inventory id="typo3/guide-frontendlocalization" url="https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/"/>
<inventory id="t3sitepackage" url="https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/"/>
<inventory id="t3start" url="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/"/>
<inventory id="t3tsconfig" url="https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/"/>
<inventory id="ext_felogin" url="https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/"/>
<inventory id="ext_form" url="https://docs.typo3.org/c/typo3/cms-form/main/en-us/"/>
<inventory id="ext_indexed_search" url="https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/"/>
<inventory id="ext_recycler" url="https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/"/>
<inventory id="ext_seo" url="https://docs.typo3.org/c/typo3/cms-seo/main/en-us/"/>
</guides>
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit d60233c

Please sign in to comment.