-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Switch Tutorial in main branch to the new rendering (#147)
* [TASK] Render as draft with the render-guides * [TASK] Remove superfluous "only" directive * [TASK] Correct guides.xml * [TASK] Delete wrong guides.xml location * [TASK] Introduce test workflow * [TASK] Introduce make for rendering and codesnippets * [TASK] Remove manually defined inventories (#146) * [TASK] Move missing information from Settings.cfg to guides.xml
- Loading branch information
Showing
7 changed files
with
56 additions
and
71 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: 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
This file was deleted.
Oops, something went wrong.
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,20 @@ | ||
<?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" | ||
> | ||
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" | ||
edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage" | ||
edit-on-github-branch="main" | ||
typo3-core-preferred="main" | ||
project-home="https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/" | ||
project-contact="https://typo3.slack.com/archives/C028JEPJL" | ||
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage" | ||
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage/issues" | ||
/> | ||
<project title="Sitepackage Tutorial" | ||
version="main (development)" | ||
release="main (development)" | ||
copyright="since 2017 by the TYPO3 contributors" | ||
/> | ||
</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,14 @@ | ||
.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: codesnippets | ||
codesnippets: ## Regenerate automatic code snippets | ||
.Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/ | ||
|
||
.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 |