Re: Moving documentation to git
| From: | Andreas Heigl | Date: | Sun, 09 Jul 2017 07:08:18 +0000 |
| Subject: | Re: Moving documentation to git | ||
| References: | 1 2 3 4 5 6 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386667@lists.php.net to get a copy of this message | ||
Hey Yannick.
> Am 08.07.2017 um 22:38 schrieb Yannick Torrès <yannick.torres@gmail.com>:
>
> Dan,
>
> You just can't say that :
>
> 1/ "edit.php.net is quite difficult to use" : Can you just remember when this editor
> don't exist ? Traductor just don't translate the documentation. The VCS processus was too
> difficult for many people, and the documentation was just translated into one or two langages. After
> the editor, a lot of people have contributed to the translation processus. It's just the
> reality.
The online-editor is a great tool and helped to boost translation and optimization of the docs.
Thank you for creating it. But as time and especially technology moves on things can become
outdated. That's not a bad thing. And from todays POV edit.php.net is more complicated to use
than for example the code-editor in GitHub or GitLab.
>
> 2/ "people don't need to be able to edit stuff on a website" : Wrong ! As I say
> before, this possibility allow "lambda user" to contribute. Just don't think that
> only "best user" must contribute to the documentation.
And I can only second your opinion here! We DO need an online-editor for the docs. And if the docs
will be hosted on git.php.net (which isn't decided yet) we might need edit.php.net as editor.
But it will be measured against GitHub or GitLab.
>
> 3/ "see whether their changes break the build" : There is already a tool who verify
> if the build can be break when the file is saved. This tool can't cover all error, but it
> exist.
But that tool wasn't integrated in the edit.php.net process. When moving to git we will add
that tool to the build-chain so a contributor will know right from the start whether that change
breaks the build or not.
>
> When you say that the preview don't work : the preview is linked with Phd installation on
> the same server. The editor just return le result of Phd. There is a problem with this processus,
> but it can be fixed easily.
But it isn't fixed and currently the infrastructure-team is... not as responsive as it could
be... Having a CI-build with a config in the repo would allow everyone interested to fix the build.
> So...
>
> Just one more thing :
>
> I'm french and french translator for the documentation, and I decided to develop this tool
> until many many many months. I spend a lot of time to make it. Some users help me to do it better (a
> lot of thanks for her).
> So please, if you can just respect this very hard work, il would be great.
Thank you Yannick for your time and the effirt you invested into making this tool!!!
It was and still is a reason the docs are as good as they are and I very much appreciate your
efforts.
Cheers
Andreas
PS: As I'm currently on holiday I won't be able to respond immediately to mails.