Re: Moving documentation to Git
| From: | Andreas Heigl | Date: | Thu, 12 Oct 2017 11:15:20 +0000 |
| Subject: | Re: Moving documentation to Git | ||
| References: | 1 2 3 4 5 6 7 8 9 10 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386738@lists.php.net to get a copy of this message | ||
Hi Christoph.
> Am 12.10.2017 um 12:18 schrieb Christoph M. Becker <cmbecker69@arcor.de>:
>
> Hi Andreas!
>
> On 12.10.2017 at 07:07, Andreas Heigl wrote:
>
>>> Am 10.10.2017 um 22:30 schrieb Christoph M. Becker <cmbecker69@arcor.de>:
>>>
>>> On 10.10.2017 at 20:42, Andreas Heigl wrote:
>>>
>>>>> Am 10.10.2017 um 12:05 schrieb Derick Rethans <derick@php.net>:
>>>>
>>>>> Wasn't the main issue here, on how to show which translations needed
>>>>> updating? Right now, that happens by comparing SVN revision numbers,
>>>>> which are handily incremental. Git hashes are not like that.
>>>>
>>>> I went around that by comparing the last change date of the english and the
>>>> translated doc as well as how many revisions where created since then of the resp. documents in the
>>>> english and the translated repo.
>>>
>>> Both comparisons are irrelevant. It is not rare, that a typo in a
>>> translation which is out-dated is applied as quick fix – still leaving
>>> the translation out-dated. It seems to me that we still need some
>>> manual way of increasing the revision (in the broadest sense) of a
>>> translation, and to compare this to the original's revision.
>>
>> They might be irrelevant. But ATM I tried to move the features we currently have with SVN
>> to a GIT-based VCS. And - as far as I understood - that is an issue with the SVN workflow as well.
>> So while we should try to find a way to implement that, IMO it should not hinder the transition to
>> git.
>
> I would really very much appreciate if we move the docs to Git(hub),
> mostly because the Online Editor lacks communication capabilities (at
> least regarding anonymous users). Sometimes is just not clear, what a
> patch is going to accomplish, due to vast amounts of whitespace changes;
> sometimes patches are partially good, but contain also errors. Often
> such patches will simply be deleted or ignored.
>
> However, presently the SVN workflow regarding translations is quite
> suitable. All files have a (sequential) SVN Id, and each translation
> has an EN-Revision comment which correlates to the SVN Id of the
> translated document. If only a quick typo fix is done in a translation,
> one can simply leave the EN-Revision untouched. This typically is the
> case if an Online Editor patch is applied, or a doc bug is fixed. Only
> if the translation is actually synched with the original, the
> EN-Revision is increased.
>
> It seems to me, that this is not yet possible with the Git version.
This is still possible as the EN-revision tag is still used but now contains the hash instead of the
revision number. So when you leave the Hash untouched it‘s the same as leaving the Revision-ID
untouched. Theee is currently no automated action to change that. And I‘d strongly oppose such an
idea. ;)
cheers
Andreas
>
> Since you have only replied to me (probably because I sent the message
> first with a "wrong" mail address), I'm replying only to you. Feel free
> to forward to the list, if desired. :)
>
> Cheers,
> Christoph
>