Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:122204
MIME-Version: 1.0
References: <CABVsipiYXnOYpLhybA3pN+eiy_ugUeLFiJN4QPvdOdQWUdwJyQ@mail.gmail.com>
In-Reply-To: <CABVsipiYXnOYpLhybA3pN+eiy_ugUeLFiJN4QPvdOdQWUdwJyQ@mail.gmail.com>
Date: Sun, 21 Jan 2024 22:56:36 +0100
Message-ID: <CAPyj-LDg8p_ekQLs0dCBjL2_v=RhY=-TB2U-q4dJT80yVcuZmw@mail.gmail.com>
To: PHP internals <internals@lists.php.net>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Subject: Re: [PHP-DEV] Wiki Access request
From: tovilo.ilija@gmail.com (Ilija Tovilo)

Hi Carlos!

On Fri, Jan 19, 2024 at 4:56=E2=80=AFPM Barel <barel.barelon@gmail.com> wro=
te:
>
> This page in the Wiki https://wiki.php.net/internals/references has a lot
> of links which are outdated and should be removed or changed. If you can
> provide wiki edit access for me I can work on updating them and also try =
to
> find more recent links to add to that reference page (suggestions welcome=
!!)
>
> My username for the wiki site is "barelon" in case this is needed

I can absolutely give you write access to these pages. Updating this
list to reflect more up-to-date resources certainly makes sense.

As you probably know, there are a number of different places where php
internals are documented, and I think that, long-term, it makes sense
to try to consolidate these efforts. We briefly spoke about this in
the last foundation meeting.

We have some documentation in the php-src repository itself, a
significant amount in the php internals book
(https://www.phpinternalsbook.com/), some in the wiki, some on blogs
of current or previous contributors, etc. There are a number of things
that are important when it comes to documentation, like convenience,
access, history, discoverability, etc.

While not the worst, I don't think the wiki is the best place for this
work. Handling documentation directly through Git in PHPs main
repository (or at least a repository in the PHP organization) would
likely tick the most boxes. Providing documentation with PRs might
also improve the understanding of intention of the changes for
reviewers.

As for links to other references, I believe the CONTRIBUTING.md file
is currently the most up-to-date.

https://github.com/php/php-src/blob/master/CONTRIBUTING.md#technical-resour=
ces

Rather than duplicating this list on the wiki, it might make sense to
reference the CONTRIBUTING.md file, and extend it as necessary.

Ilija