-
Notifications
You must be signed in to change notification settings - Fork 833
Add a Docker Compose setup for building and serving PHP documentation locally #4962
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
base: master
Are you sure you want to change the base?
Conversation
afilina
left a comment
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.
I like this workflow a lot. Merci!
I followed the instructions for default and fr on both Linux and PowerShell. Everything behaves as expected. I left some usability and other suggestions in the review comments.
Future improvement ideas (I can open issues once this is merged, and we can have discussions about each item at that time):
- Ask whether the user wants to clone missing dependencies.
- Remove the previous docker-based workflow.
409431b to
59500e1
Compare
afilina
left a comment
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.
Thanks for incorporating the suggestions. Just the directory check that doesn't seem to behave as expected. See details in the comment.
d901bba to
f3772ca
Compare
afilina
left a comment
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.
It still says "doc-fr is missing or incomplete!" even after I clone it. Please test the full workflow (starting at missing doc-fr and doc-base) before submitting for review again. This will allow you to catch and fix errors early.
Also if you could add changes as a separate commit for each review iteration, as squashing means I have to re-read everything each time, and I've done this multiple times already. Thanks.
|
Thanks again for the review @afilina |
|
I'm on my way to a conference overseas, so I won't be able to give it another review until Sunday. |
afilina
left a comment
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.
@lacatoire Looks like the last change went to the other extreme and we're now back to "Could not open input file: configure.php". Newcomers will not always connect this error message to the skipped step in the docs, and will open issues, which the documentation team will need to address.
I feel like you were really close. You just need to check the right files at the correct time, with an error message guiding towards the solution, and then test both the happy path and the "missing repos" path.
|
Thanks! I’ve updated the script to detect the correct language directory and to check a stable file. This keeps the workflow simple while giving clear guidance if a repo is missing. Let me know if anything else looks off! |
|
Thanks for resolving the missing folder checks. There seems to be a regression in the main functionality. When running without LANGUAGE, everything is fine, But when running for
And the URL says "The requested resource / was not found on this server." A bit higher up, there were other errors in the console that might be relevant:
Please ensure the PR is fully tested after the next fix. |
Description
This PR adds a simple Docker Compose workflow to build and preview the PHP manual locally.
It provides a lightweight, cross-platform alternative to the existing make setup and works on Linux, macOS, and Windows (including PowerShell).
The goal is to make contributing to the documentation easier for new and existing contributors by removing installation steps and dependency issues.
Highlights
Technical notes
Does not modify the existing make build process this is an optional, self-contained alternative.
Impact
This setup should lower the barrier to entry for contributors and make it easier to test translations and improvements locally, without manual setup.