Re: Moving documentation to git
| From: | Yannick Torrès | Date: | Sat, 08 Jul 2017 20:38:15 +0000 |
| Subject: | Re: Moving documentation to git | ||
| References: | 1 2 3 4 5 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386666@lists.php.net to get a copy of this message | ||
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..
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.
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.
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.
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.
Best,
Yannick
Le sam. 8 juil. 2017 à 20:28, Dan Ackroyd <danack@basereality.com> a écrit :
> On 16 June 2017 at 16:44, Ben Ramsey <ben@benramsey.com> wrote:
> >
> > The purpose of edit.php.net is so that people can provide edits without
> > needing to go through the documentation build process,
>
> That's the theory. In practice edit.php.net is quite difficult to use.
> For example the preview just does not work for me.
>
> Reviewing commits is also a not entirely fun task in it.
>
> > I think we’d still keep edit.php.net. We should try to address the
> > accessibility issues it has.
>
> Fixing it would be massive task. And possibly the wrong goal anyway.
>
> People don't need to be able to edit stuff on a website - they need to
> be able to see whether their changes:
>
> i) Break the build.
> ii) Look correct.
>
> Neither of those things are related to an online editor - but are
> related to automated builds and branches, the tools for which are much
> more potent now than they were when the original docs were created.
>
> cheers
> Dan
>