Re: Moving the documentation to git

This is only part of a thread. view whole thread
February 12, 2020 06:31 andreas@heigl.org (Andreas Heigl)
--p3cEWx6lh0KYY8ABO6IzIomMpCs7FCSdk
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: quoted-printable

Hey Internals and docs-folks

On Monday we finished the first important step of moving the
documentation to git.

Nikita created all the missing repos and Peter provided me with push
access to all those repos via the phpdocbot account. I then cloned all
currently active language-repos using an authors map from SVn to git and
pushed the result to git.php.net/doc. Now the docs are continuously
fetched from SVN, converted to git and pushed to their respective repos.
The english docs every 15 minutes and the translations every two hours.

Currently the leading system (the Single Source Of Truth) is still SVN!

But people can now already contribute via git to the docs as =E2=80=93 at=
 least
as far as I understood =E2=80=93 the process of pushing changes from git =
to SVN
is more or less automated (correct me if I'm wrong here, Nikita/Peter).

Now the next steps are to move the toolage from SVN to git.

That means:

* Switch Source Retrieval for Docs building on docs.php.net from
svn.php.net to git.php.net
* Switch Generation of revcheck-files from svn to git (Work is already
done at
https://github.com/phpdoctest/doc-base/blob/master/scripts/revcheck.php)
* Verify that everything works as expected

When that is finished and accepted we can move over to the next stage:

* Switch Source Retrieval for Docs building on rsynv.php.net from SVN to =
git
* Setup Mirroring and processes to merge PRs from GitHub to
documentation git.
* Rewrite setup-instructions and send email to docs team regarding new
process

And then we can finally make SVN readonly.

(and the cronjobs on svngit.php.net need top be shut down)

I've also added the ToDo list to
https://github.com/phpdoctest/meta/wiki/todo, so that everyone can
follow the process.


As the next steps need access to euk2.php.net which I currently do not
have, I'd need someone to actually do those next tasks. Access =E2=80=93
according to the wiki =E2=80=93 have bjori, mgdm, mj, nilgun, philip, sal=
athe,
sobak, tyrael and yannick. I'd be very happy if one of you could ping me
so that we can check the next steps.

Thank you all for the support during the last weeks.

Cheers

Andreas



Am 04.02.20 um 08:09 schrieb Andreas Heigl:
> Hey folks. >=20 > During the last year I took a bit of time aside to bring the > documentation from SVN to git. And about a month ago I informed the > DOCs-Mailinglist about the current status and the fact that we are read= y
> to move to the next step[1]. Now some tasks need to be done by people > with appropriate karma to be able to get on with the whole thing, but > all the background tasks are done and awaiting further processing. >=20 > Sadly there was no response so far. Neither on the email as such nor on=
> the different tasks. >=20 > So the main question is now, how the PHP-Project wants to go on with > moving the documentation from SVN to git? Is there any interest in > continuing this project? And if so, who can either take on the necessar= y
> steps or provide us with the appropriate credentials and access rights > that we can do them ourselves? >=20 > Thanks for reading and looking forward to the results. >=20 > Cheers >=20 > Andreas >=20 > [https://news-web.php.net/php.doc/969387429] >=20
--=20 ,,, (o o) +---------------------------------------------------------ooO-(_)-Ooo-+ | Andreas Heigl | | mailto:andreas@heigl.org N 50=C2=B022'59.5" E 08=C2=B0= 23'58" | | http://andreas.heigl.org http://hei.gl/wiFKy7 | +---------------------------------------------------------------------+ | http://hei.gl/root-ca | +---------------------------------------------------------------------+ --p3cEWx6lh0KYY8ABO6IzIomMpCs7FCSdk--
February 12, 2020 19:48 internals@lists.php.net ("Andre Polykanine via internals")
Hello Andreas,

> But people can now already contribute via git to the docs as – at least
Does that mean that we can skip the (inaccessible) edit.php.net and send pull requests on Github? Thanks! -- With best regards from Germany, Andre Skype: menelion_elensule Twitter (English only): @AndrePolykanine ------------ Original message ------------ From: Andreas Heigl <andreas@heigl.org> To: internals@lists.php.net Date created: , 7:31:17 AM Subject: Moving the documentation to git Hey Internals and docs-folks On Monday we finished the first important step of moving the documentation to git. Nikita created all the missing repos and Peter provided me with push access to all those repos via the phpdocbot account. I then cloned all currently active language-repos using an authors map from SVn to git and pushed the result to git.php.net/doc. Now the docs are continuously fetched from SVN, converted to git and pushed to their respective repos. The english docs every 15 minutes and the translations every two hours. Currently the leading system (the Single Source Of Truth) is still SVN! But people can now already contribute via git to the docs as – at least as far as I understood – the process of pushing changes from git to SVN is more or less automated (correct me if I'm wrong here, Nikita/Peter). Now the next steps are to move the toolage from SVN to git. That means: * Switch Source Retrieval for Docs building on docs.php.net from svn.php.net to git.php.net * Switch Generation of revcheck-files from svn to git (Work is already done at https://github.com/phpdoctest/doc-base/blob/master/scripts/revcheck.php) * Verify that everything works as expected When that is finished and accepted we can move over to the next stage: * Switch Source Retrieval for Docs building on rsynv.php.net from SVN to git * Setup Mirroring and processes to merge PRs from GitHub to documentation git. * Rewrite setup-instructions and send email to docs team regarding new process And then we can finally make SVN readonly. (and the cronjobs on svngit.php.net need top be shut down) I've also added the ToDo list to https://github.com/phpdoctest/meta/wiki/todo, so that everyone can follow the process. As the next steps need access to euk2.php.net which I currently do not have, I'd need someone to actually do those next tasks. Access – according to the wiki – have bjori, mgdm, mj, nilgun, philip, salathe, sobak, tyrael and yannick. I'd be very happy if one of you could ping me so that we can check the next steps. Thank you all for the support during the last weeks. Cheers Andreas Am 04.02.20 um 08:09 schrieb Andreas Heigl:
> Hey folks. > > During the last year I took a bit of time aside to bring the > documentation from SVN to git. And about a month ago I informed the > DOCs-Mailinglist about the current status and the fact that we are ready > to move to the next step[1]. Now some tasks need to be done by people > with appropriate karma to be able to get on with the whole thing, but > all the background tasks are done and awaiting further processing. > > Sadly there was no response so far. Neither on the email as such nor on > the different tasks. > > So the main question is now, how the PHP-Project wants to go on with > moving the documentation from SVN to git? Is there any interest in > continuing this project? And if so, who can either take on the necessary > steps or provide us with the appropriate credentials and access rights > that we can do them ourselves? > > Thanks for reading and looking forward to the results. > > Cheers > > Andreas > > [https://news-web.php.net/php.doc/969387429] >
-- ,,, (o o) +---------------------------------------------------------ooO-(_)-Ooo-+ | Andreas Heigl | | mailto:andreas@heigl.org N 50°22'59.5" E 08°23'58" | | http://andreas.heigl.org http://hei.gl/wiFKy7 | +---------------------------------------------------------------------+ | http://hei.gl/root-ca | +---------------------------------------------------------------------+