Re: [PHP-DEV] Re: Wiki Access request
On Wed, Jan 24, 2024 at 1:22 PM Ilija Tovilo wrote: > > Thank you for the list. It looks more digestible, and most of it is > already congruent with CONTRIBUTING.md. > > * https://www.zend.com/resources/writing-php-extensions requires > sharing your contact infomation to obtain. I'm not sure how other > people feel about this. Oh, nevermind. That sidebar is clickable. I missed that there's an online version. Ilija -- PHP Internals - PHP Runtime Development Mailing List To unsubscribe, visit: https://www.php.net/unsub.php
Re: [PHP-DEV] Re: Wiki Access request
Hi Carlos On Wed, Jan 24, 2024 at 12:29 PM Barel wrote: > > > Feel free to share this list here, on GitHub or otherwise. I'm > > skeptical whether throwing partially outdated resources at people is > > actually helpful. > > I trimmed the list that I collected so that it only included the most > significant items which have a lot of information. This list would be: > - https://www.phpinternalsbook.com/ PHP Internals book > - https://phpinternals.net/ PHP Internals web site with documentation about > a lot of the structures and macros used in the code > - https://www.npopov.com/ Nikita Popov's blog > - http://blog.jpauli.tech/ Julien Pauli's blog > - https://phpinternals.news/ Derick Rethans' podcast > - https://www.zend.com/resources/writing-php-extensions Zend's guide about > writing PHP extensions > - https://wiki.php.net/internals The internals page in the wiki > - https://www.informit.com/store/extending-and-embedding-php-9780672327049 > Sara Golemon's printed book > > Do you think this sounds good? If you do, I will create the PR to update > the contributing doc Thank you for the list. It looks more digestible, and most of it is already congruent with CONTRIBUTING.md. * Juliens blog is a bit large, but contains some very detailed posts that should still be relevant. It might make sense to list them explicitly. * https://www.zend.com/resources/writing-php-extensions requires sharing your contact infomation to obtain. I'm not sure how other people feel about this. * https://www.informit.com/store/extending-and-embedding-php-9780672327049 might be outdated, as it was published back in the PHP 5.1 era. I'll leave it up to Sara whether she thinks the book should be recommended at this time. The rest seems to be already listed. Regards, Ilija -- PHP Internals - PHP Runtime Development Mailing List To unsubscribe, visit: https://www.php.net/unsub.php
[PHP-DEV] Re: Wiki Access request
> > > Feel free to share this list here, on GitHub or otherwise. I'm > skeptical whether throwing partially outdated resources at people is > actually helpful. > > > - 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 > > One of the reasons I'd like to move off of the wiki for these things > is that there is no review process. We highly value volunteer work, > but trusting new contributors to blindly make changes to official > guides is obviously somewhat problematic. > > I'd prefer to make CONTRIBUTING.md the "official list" for now. This > file is allowed to be long. And as mentioned, I suspect that the list > of 20+ items may be trimmed. > > Ilija > > Ilija, I trimmed the list that I collected so that it only included the most significant items which have a lot of information. This list would be: - https://www.phpinternalsbook.com/ PHP Internals book - https://phpinternals.net/ PHP Internals web site with documentation about a lot of the structures and macros used in the code - https://www.npopov.com/ Nikita Popov's blog - http://blog.jpauli.tech/ Julien Pauli's blog - https://phpinternals.news/ Derick Rethans' podcast - https://www.zend.com/resources/writing-php-extensions Zend's guide about writing PHP extensions - https://wiki.php.net/internals The internals page in the wiki - https://www.informit.com/store/extending-and-embedding-php-9780672327049 Sara Golemon's printed book Do you think this sounds good? If you do, I will create the PR to update the contributing doc Cheers Carlos
Re: [PHP-DEV] Re: Wiki Access request
Hi Carlos You should now have access to the /internals sub-pages. On Mon, Jan 22, 2024 at 11:38 AM Barel wrote: > > 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 Feel free to share this list here, on GitHub or otherwise. I'm skeptical whether throwing partially outdated resources at people is actually helpful. > - 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 One of the reasons I'd like to move off of the wiki for these things is that there is no review process. We highly value volunteer work, but trusting new contributors to blindly make changes to official guides is obviously somewhat problematic. I'd prefer to make CONTRIBUTING.md the "official list" for now. This file is allowed to be long. And as mentioned, I suspect that the list of 20+ items may be trimmed. Ilija -- PHP Internals - PHP Runtime Development Mailing List To unsubscribe, visit: https://www.php.net/unsub.php
[PHP-DEV] Re: Wiki Access request
> > > 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
