-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[TASK] Switch Documentation Rendering to PHP #113
Conversation
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log | |
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test |
Documentation/guides.xml
Outdated
project-issues="https://github.com/FriendsOfTYPO3/introduction/issues" | ||
edit-on-github-branch="main" | ||
edit-on-github="FriendsOfTYPO3/introduction" | ||
typo3-core-preferred="stable" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo3-core-preferred="stable" | |
typo3-core-preferred="main" |
Documentation/guides.xml
Outdated
/> | ||
<inventory id="t3coreapi" | ||
url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/" | ||
/> | ||
<inventory id="t3install" | ||
url="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/" | ||
/> | ||
</guides> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/> | |
<inventory id="t3coreapi" | |
url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/" | |
/> | |
<inventory id="t3install" | |
url="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/" | |
/> | |
</guides> | |
/> | |
</guides> |
Makefile
Outdated
.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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log | |
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test |
Thanks a lot for taking care of this! Just some small remarks |
.idea/.gitignore
Outdated
@@ -0,0 +1,8 @@ | |||
# Default ignored files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please delete the .idea folder from your PR: It is for local development only and should not be commited.
Best add it to the .gitignore instead
150e5e4
to
73455ee
Compare
Resolves: FriendsOfTYPO3#112 Releases: main
73455ee
to
6175756
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, looks good!
You can try out the rendering locally with
Resolves: #112