-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Add missing files to render update
- Loading branch information
1 parent
80d78f3
commit d60233c
Showing
4 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |