Skip to content
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

Merged
merged 1 commit into from
Oct 13, 2024

Conversation

Alagts
Copy link
Contributor

@Alagts Alagts commented Oct 7, 2024

You can try out the rendering locally with

make docs

Resolves: #112

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

project-issues="https://github.com/FriendsOfTYPO3/introduction/issues"
edit-on-github-branch="main"
edit-on-github="FriendsOfTYPO3/introduction"
typo3-core-preferred="stable"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
typo3-core-preferred="stable"
typo3-core-preferred="main"

Comment on lines 21 to 22
/>
<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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/>
<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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

@linawolf
Copy link
Contributor

Thanks a lot for taking care of this! Just some small remarks

.idea/.gitignore Outdated
@@ -0,0 +1,8 @@
# Default ignored files
Copy link
Contributor

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

Copy link
Contributor

@linawolf linawolf left a 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!

@georgringer georgringer merged commit 87b00a0 into FriendsOfTYPO3:main Oct 13, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use the new PHP-based rendering for the documentation
3 participants