Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:122217
MIME-Version: 1.0
References: <1705874211.14975.ezmlm@lists.php.net>
In-Reply-To: <1705874211.14975.ezmlm@lists.php.net>
Date: Mon, 22 Jan 2024 11:37:56 +0100
Message-ID: <CABVsiphJTtEx_UVJx40c2jO7mfvFXQUJftLxQBub1x85ONQp=A@mail.gmail.com>
To: PHP internals <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="000000000000f52058060f866c34"
Subject: Re: Wiki Access request
From: barel.barelon@gmail.com (Barel)

--000000000000f52058060f866c34
Content-Type: text/plain; charset="UTF-8"

>
>
> 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-resources
>
> Rather than duplicating this list on the wiki, it might make sense to
> reference the CONTRIBUTING.md file, and extend it as necessary.
>
> Ilija
>
>
 Hi Ilija,

I didn't know that there was a list of tech resources listed in the
"CONTRIBUTING.md" file. I have been researching resources that have
information about PHP internals and have found a lot, more than twenty. I
can think of three possibilities:
- List them all in the contributing document but this can be a bit
overwhelming as, like I said, the number of resources available is big
- Add a new page in the Github repo with all these links and link to that
page from the contributing page
- Keep the list in the wiki and link to that page from the contributing page
Please let me know what you think would be the best way going forward.
No matter what we do, we need to make sure that this info is collected in a
single place and not duplicated. And no matter what we do, the wiki page
needs to be cleaned so I'd be grateful if you could provide this access.
Depending on what we decide to do, I will clean up the wiki and create a PR
for the php-src repo with the related changes

Cheers

Carlos

--000000000000f52058060f866c34--