Re: Maintaining PHP 5 documentation
| From: | Anna Filina | Date: | Wed, 09 Dec 2020 22:53:58 +0000 |
| Subject: | Re: Maintaining PHP 5 documentation | ||
| References: | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969387711@lists.php.net to get a copy of this message | ||
Hi team,
I made the necessary changes to the php.net code to suggest legacy manuals
in case of a 404. PR with screenshot for your perusal and comments:
https://github.com/php/web-php/pull/385.
Cheers!
Anna
On Wed, Dec 9, 2020 at 2:57 PM Anna Filina <me@afilina.com> wrote:
> Thanks George,
>
> I checked out the web-php repo, ran it locally and am now working on
> handling retired manual pages. I'll post a PR with my solution and we can
> decide on the details there. I'll try to incorporate as much of your
> feedback from this thread.
>
> Thank you all very much for being so open and helpful!
>
> Anna
>
> On Wed, Dec 9, 2020 at 1:21 PM G. P. B. <george.banyard@gmail.com> wrote:
>
>> On Wed, 9 Dec 2020 at 15:57, Anna Filina <me@afilina.com> wrote:
>>
>>> I added the readme, information about contributing and code of conduct:
>>> https://github.com/zendtech/php-legacy-docs
>>>
>>> I also have a draft of the license:
>>>
>>> https://github.com/zendtech/php-legacy-docs/pull/4/files
>>> I have no idea how to write licenses. Is the attribution good enough?
>>> Let me know what I can improve.
>>>
>>> Also, anything I can do to help with redirecting retired pages to legacy
>>> docs? I can write an nginx config, a code snippet to verify availability of
>>> legacy counterpart, etc. I booked my week for this.
>>>
>>> Anna
>>>
>>> On Tue, Dec 8, 2020 at 2:58 PM Anna Filina <me@afilina.com> wrote:
>>>
>>>> Giovanni,
>>>>
>>>> I used the HTML files that were made available by the documentation
>>>> team on http://doc.php.net/archives/
>>>> These files had a slightly different layout, included no fonts and had
>>>> no notes. I'm open to suggestions if there's a way to grab these
>>>> resources
>>>> and merge them into the HTML files.
>>>>
>>>> The notes shouldn't be part of the HTML archive on GitHub though, as I
>>>> wouldn't want them to be edited by contributors in the long run.
>>>>
>>>> Anna
>>>>
>>>> On Tue, Dec 8, 2020 at 2:03 PM Giovanni Giacobbi <giovanni@giacobbi.net>
>>>> wrote:
>>>>
>>>>> On Tue, 8 Dec 2020 at 18:44, Anna Filina <me@afilina.com> wrote:
>>>>>
>>>>>> Hi team,
>>>>>>
>>>>>> Zend has agreed to both host the legacy docs and dedicate time to
>>>>>> maintaining them. I already put together a site that displays the archives.
>>>>>>
>>>>>> The docs are available here:
>>>>>> https://php-legacy-docs.zend.com/
>>>>>> The archives are on GitHub:
>>>>>> https://github.com/zendtech/php-legacy-docs
>>>>>> (still needs readme,
>>>>>> license and all the gory details).
>>>>>> I fixed the style tags in the archives' HTML, so that contributors
>>>>>> can preview their changes locally with css.
>>>>>>
>>>>>>
>>>>> Any chance to have it actually as it is now on
>>>>> https://docs.php.net/
>>>>> including the comments the font and the layout? Like a full snapshot of the
>>>>> state previous to PHP5 eviction, I found the notes sometimes very useful.
>>>>>
>>>>>
>> I'm far from an expert on how we handle web stuff for the PHP project,
>> but maybe a good place to start is php/web-php (
>> https://github.com/php/web-php)
>>
>> And CSS/JS should be located at
>> https://github.com/php/web-shared from
>> my understanding.
>>
>> George P. Banyard
>>
>