Fixes for errors and warnings on doc-it manual build #55
Comments
|
I replaced the files from the Italian repo with those from the English repo then little by little I'm taking the files inside it/reference//function and putting them back in the new repo for now when I rebuild the documentation with "php ./base/configure. php --with-lang=it" I haven't finished yet but for now it seems to work |
|
That's great. Two notes, thought. Replacing files in translations from doc-en is almost the same effect of removing or renaming out files in translations. In the doc-pt_BR translations, we renamed very outdated files from And that removing or renaming files at least flag then tor translation, while replacing translated files from doc-en would not. But a building translation is better than a not building one, so please open a PR with this changes. |
|
Once I've finished and checked that it works I do the PR |
|
can now parse files but cannot validate .manual.xml Hi i found error in these files Untracked files: |
|
After this PRs are reviewed and merged, I will try to help identifying key files that need to be updated to push doc-it into building state again. In fact, I'm working in a tool specifically for this. The There is no @php/doc-it-team to ping, so let's wait a while to see if someone reviews and merge these PRs. |
|
ok in the meantime I'll take this opportunity to study |
DavidePastore
added
good first issue
|
Hi everyone. Thanks for the investigation that you did on the topic. As I privately shared with @ManueldG, I'm not going to merge these two PRs because they contain only English content. It's better to update the files and use Italian instead since this is the repository meant to contain the Italian translation of the PHP documentation. Feel free to propose new PRs that are updating the files accordingly. Thanks for the understanding. |
About pushing English files, one alternative is simply renaming very outdated files from
Please note that Italian manual build is broken, from several months now. While is better to have more texts translated, soon there will be no published Italian manual at all. I opened this issue to help point out what are the critical files necessary to push doc-it into building again, and avoid the manual being removed. |
|
I started using the basic structure of the English version and I'm comparing it with the Italian version so while I update the files I check if the project is built. PR #61 |
its posssible restore the last working version ? or create a branch to fix the current version ? |
|
I send a message to [email protected] |
I understand your point but I prefer to solve the issue the right way by updating and fixing the files that are causing the issue. I will take a look at it this evening. |
There are some tools I created to automate these comparisons. They are in https://github.com/php/doc-base/tree/master/scripts/translation . They already helped other translators to push their manual into building state. doc-it need more the changes pointed out from
This is a nice habit to have, but doc-it is so outdated there will be various changes that will not build the manual. Only when all changes necessary are in place that it will start building again.
No. Most translations already made the changes, so reverting doc-en to build doc-it would break all others.
Yes, but it's necessary to coordinate it with the people that have pull/merge access, or it would be not used in the end. I may continue to help pointing out what are the key files or how to fix some errors in the meanwhile.
Do not do that. Files that do not exist in doc-it are automatically pulled from doc-en. doc-en is the base, the translations are more an overlay.
The doc-it wiki mentions how in https://github.com/php/doc-it/blob/master/CONTRIBUTING.md#3-revision-tracking . To generate the same file locally, you can use
Yet, I will insist that |
Thanks, The Italian speaking developers will appreciate that. One question, you are aware the build manual failures are send to lists no more? Also, you may be interested in read this: php/doc-base#111 (review) . This was the case of another language that have a comeback from being unpublished. Another thing that helped so much another language was organizing an "translation fest". |
|
How should I use these files? qaxml.e.php and qaxml.a.php? |
|
@alfsb and @ManueldG, the build is now green. Can I close this issue now or do you need any support? |
|
Close, yes. On the question of support, I'm rewriting the qaxml tools under The actual qaxml tools are mostly focused on languages with no outdated files in revcheck. The new tools will inspect all files. As there is email alerts no more, the only way to detect broken builds is to run the |
There is a README.md on the link https://github.com/php/doc-base/tree/master/scripts/translation . But as comment above, these tools help, but are not focused on languages in broken state. I'm creating new tools that will serve |
|
Ok thanks !!
Il giorno lun 10 feb 2025 alle ore 13:44 alfsb ***@***.***>
ha scritto:
… How should I use these files? qaxml.e.php and qaxml.a.php?
There is a README.md on the link
https://github.com/php/doc-base/tree/master/scripts/translation . But as
comment above, these tools help, but are not focused on languages in broken
state. I'm creating new tools that will serve doc-it better, in the same
directory. Keep a watch on this folder, as the new tools will placed here.
—
Reply to this email directly, view it on GitHub
<#55 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ARXQKK3L346GOLCFJCCRABL2PCNMBAVCNFSM6AAAAABTR3TGLCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNBXHA4DEMBRHA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Thanks for your tips and information. I wasn't aware that the manual build failures weren't sent any more. I don't understand why this choice was taken. Do you have any additional details about this? |
Several months ago, the machine that builds manuals broke, and while configuring the new machine, emails from broken builds, and emails from commits are removed or not added. You need to interview the new machine maintainers for more details. |
|
Before closing, I suggest running |
|
I tried to run I would like to report the error in issues |
Hi @php/doc-tr-team . To (almost) fix manual building,
language/oop5.xmlmust be updated, to include:There are various XInclude warnings. Most of then can be fixed by updating (or renaming out)
reference/filesystem/functions/fgetcsv.xml.This will leave only two other files causing XInclude warnings, the file for
function.bcdivand the file forfunction.gmp-init. These may be fixed after one change ondoc-basegoes live.Let me know if these help, into making doc-it a live project again.
The text was updated successfully, but these errors were encountered: