Re: Github Mirrors of git.php.net/docs

Andreas Heigl <[email protected]> Sun, 27 Dec 2020 17:04:50 +0100
Newsgroups	gmane.comp.php.documentation.general
Message-ID	<[email protected]>
Hey Nikita

Am 27.12.20 um 14:59 schrieb Nikita Popov:
> On Sun, Dec 27, 2020 at 11:30 AM Andreas Heigl <[email protected]
> <mailto:[email protected]>> wrote:
> 
>     Hey Nikita
> 
>     Am 27.12.20 um 10:44 schrieb Nikita Popov:
>     > On Sat, Dec 5, 2020 at 6:01 PM Andreas Heigl <[email protected]
>     <mailto:[email protected]>
>     > <mailto:[email protected] <mailto:[email protected]>>> wrote:
>     >
>     >     Hey folks.
>     >
>     >     TL;DR
>     >
>     >     1. Who can create github mirrors of translations in git?
>     >     2. Who can review and merge a systems PR and get the changes onto
>     >     euk2.php.net <http://euk2.php.net> <http://euk2.php.net>?
>     >     3. If 1. and 2. result in "no one": Who can grant me access to
>     do that
>     >     and guide me through the process?
>     >
>     >     Long version:
>     >
>     >     For some time now we do have the doc-en mirror on github of
>     >     git.php.net:/doc/en.git. People are already happy in
>     contributing via
>     >     PRs to that and therefore to the PHP-Documentation.
>     >
>     >     Whom do I need to bribe (or simply contact) to get that setup
>     for the
>     >     translations as well? Yes, I know that puts up an extra burden
>     onto the
>     >     docs maintainers by having to backport that to SVN. But as the
>     plan is
>     >     to move the docs from SVN to git anyhow (and rather sooner
>     than later)
>     >     why should the translations not benefit from that? And I'm
>     sure we can
>     >     get some volunteers to take care of the backporting until we have
>     >     finished the transition. I would definitely be one of them.
>     >
>     >     Besides that the current status of the transition is that the
>     git repos
>     >     are constantly updated from SVN and there's a PR to systems to
>     move the
>     >     creation of the documentation from using SVN as the base to
>     using git as
>     >     the base. Though I fear that the PR is not going to help as
>     the files
>     >     seem to be out of sync and there are already manual changes in the
>     >     touched files. Whom can I contact to get that PR merged and
>     the changes
>     >     put onto the system?
>     >
>     >     Or, as an option: Who can grant me the necessary rights to do
>     it myself
>     >     and who can guide me through the process of doing so?
>     >
>     >     Cheers
>     >
>     >     Andreas
>     >
>     >
>     > Hi Andreas,
>     >
>     > I can add mirrors, but intentionally didn't do this for the
>     translation
>     > repos to avoid future issues with force pushes.
>     >
>     > I don't think we'll want to use the translation repos in the current
>     > form, because the separate file for tracking EN revisions seems like a
>     > really big PITA for translators. This originally came about due to
>     > trouble with continually rewriting the history to map SVN revisions to
>     > Git revisions while syncing the repos. I think that given how things
>     > turned out, continuous SVN -> Git sync with rewritten history doesn't
>     > seem like much of a priority anymore. I think it would be fine to just
>     > do a one-time history rewrite when we switch, or even just a one-time
>     > replacement of revisions in files (ultimately, the history rewrite is
>     > not super important).
>     It's how the current transition is build. To be quite honest: I'm not
>     really willing to put any more time and energy into this project that is
>     already pretty draining with having to chase people down to get anything
>     done. So I'm not going to do any further changes to the current system.
>     As the revcheck isn't setup at this point in time anyhow (which is the
>     only thing that extracts this information) and there was a chat between
>     Paul Dragoonis, Gabriel Caruso and myself to leave this as a task for
>     someone else after the move to git was made, that task would also
>     include a decent way to include the EN revision/hash.
> 
>     If the PHP community wants to wait for the move from svn to git until
>     this is solved: Find someone else to do it.
> 
> 
> I don't think fixing revcheck in advance is particularly important, I
> just want to retain the current format of EN-Revisions stored in each
> file (just with git hashes instead of SVN revisions).
I'm absolutely with you on that!
> 
> Basically, I want to run this script after writes to SVN have been
> disabled and before writes to Git are enabled:
> https://gist.github.com/nikic/8ee88a817db794aff15adb7e07754e23 It just
> moves the hashes back into EN-Revision and drops the .en-revisions.ref
> file. It does need something like 20 minutes per repo, but it's a
> one-time cost.
Sounds like a great plan once we switched off svn!

> 
> Does that sound reasonable to you? Basically, the plan would be:
> 1. Remove phpdoc SVN karma from everyone. (me)
> 2. Disable SVN -> Git mirroring. (you)
> 3. Run above script to move hashes back into EN-Revision and force push
> repos. (you or me)
> 4. Add Git karma for everyone. (me)
> 5. Set up GitHub mirrors (me)
> And I think this is something we could do anytime now, if I understood
> your right that the online docs are *already* being built from Git.

That sounds like an excellent plan! Count me in!

Though currently the docs are not yet built from git as that was waiting
for the PR to be merged - which now that you did that I will add to euk2
so that from tonight on the docs will be built from git and not from SVN
any more. I would like to give that process a day to check whether
everything is *really* working as expected and then we can move on.

As currently only the english docs are available via github no further
action is necessary there as we do not need to rewrite history for that,
only for the translations. So it makes perfect sense to create the
mirrors only *after* the switch!

Do we get that done this year?

Looking forward to it! And thanks for taking the initiative!

Cheers

Andreas

PS:
> 
> PS: I noticed that .en-revisions.ref is missing entries for .ent files.
> But I guess fixing this is more trouble than it's worth, as there's just
> three of them.
Thanks! ;-)

>  
> 
>     >
>     > As to the systems PR, I can merge that as well, but I don't know about
>     > getting changes on euk2. The wiki says that you have access to that
>     > system. Is that the only system that needs to be updated to build from
>     > git? It sounds like this one is responsible for building
>     docs.php.net <http://docs.php.net>
>     > <http://docs.php.net>, but does it build the main php.net
>     <http://php.net>
>     > <http://php.net> as well?
>     I do have access to the system and so far it looks like the changes to
>     systems were never actually applied to euk2 as the files I've adapted in
>     the PR contain different code on euk21 than in the repository (which I
>     stated in one of my previous emails). So it would be easy for me to
>     actually *do* the changes on the machine, but I wanted to go the
>     *proper* way to not go over peoples heads.
> 
>     So if I understand you right the proper way would be to checkout the
>     current version of the systems git-repo on euk2? I can prepare and
>     arrange that then.
> 
> 
> It looks like there is supposed to be an hourly cron job that runs
> update-systems
> (https://github.com/php/systems/blob/0804b019304316723a072146563107471b0be2ae/boxen/euk2.php.net).
> Could you check whether that is running? But otherwise, doing a manual
> update sounds reasonable (I've just merged your PR).
I'll check that but the git repo at /local/systems on euk2 has the last
commit from 2015 and origin/master from 2019. Interestingly the first
missing commit is "Moving euk2 to new box" so I assume that there has
something gone south during that move...

I'd rather see to fixing that *after* the move. Looks like some stuff
has gotten out of sync after a manual edit and then the git pull didn't
work anymore...

I'll need more time fixing that as I need to figure out what is exactly
doing what and there are local changes that need to be incorporated into
the repo before being able to do a clean fetch and reset for the machine.

-- 
                                                              ,,,
                                                             (o o)
+---------------------------------------------------------ooO-(_)-Ooo-+
| Andreas Heigl                                                       |
| mailto:[email protected]                  N 50°22'59.5" E 08°23'58" |
| https://andreas.heigl.org                                           |
+---------------------------------------------------------------------+
| https://hei.gl/appointmentwithandreas                               |
+---------------------------------------------------------------------+
signature.asc (application/pgp-signature, 833 B)