Re: Moving documentation to Git

> Nowadays a git based source-control allows so much more like easier > automation of tasks especially in a Pull/Merge-Request based workflow. > Interaction based on Pull- or Merge-Requests makes collaboration so much > easier. But most of the developers these days would also expect a way to > do code-reviews on these Requests. And forwarding a DIFF via email is > technically perfectly OK but well… > > So for me moving the PHP-Docs from SVN to GIT also means shifting from a > workflow where only a few had access to the repository and getting a > change into the documentation from a non-regular contributor meant a lot > of tedious work and relying on the time of someone (who often wasn't > actually known) to get the changes you did on edit.php.net actually into > the sources. And when that eventually happened you might not wven know > about that. > > In a more modern workflow - and that's more or less what we know from > github - I'm able to spot an issue in the docs, head over to the > web-frontent of the repo (probably by a link on the docs-page itself) > propose a change of the docs by a pull- or merge-request and get > notified when someone merges it into the master branch. Apart from that > I don't need to setup the whole environment myself to verify the Request > is valid but the underlying CI-system picks up the request, runs some > tests on it and marks them as faulty or valid. And last not least the > people responsible for the repository are known and can be addressed > directly should a PR be in the pipeline for too long (however that might > be defined (-; ) We will have no problems using a modern Git workflow with PHP docs if they reside in git.php.net with mirrors on GitHub. In fact, the workflow you’ve described is exactly how all the other PHP repositories work. Their central repositories are hosted on git.php.net, the mirrors are on GitHub, and we are able to review and accept pull requests on GitHub into git.php.net. If you take a look at https://qa.php.net/pulls/, you can see a little bit of how this works. If you have karma to a specific repository and you use the “Login” link there, then you’re able to merge a pull request directly from GitHub into the repository on git.php.net, which in turn, updates everything through to GitHub. The infrastructure is already there for the workflow, so I don’t think that’s a blocker for moving to Git. The blockers are in the build environment and build scripts. They’ll need to be updated to support Git, and we’ll need to figure out how to handle all the language directories. -Ben

Attachment: [application/pgp-signature] Message signed with OpenPGP using GPGMail signature.asc