-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Document PHP extensions #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Thanks! Was thinking of writing something like this, in my draft, I presented the list of extensions as a table, containing a column that showed if an extension was built statically, or shared, and a column with the name of the extension ( e.g. |
I just tested, and a table won't work. The Hub's markdown renderer doesn't support it. Also, who's going to volunteer to keep this list up to date? 😄 (I'm +1 on the list existing, but I don't much care to maintain it myself, and I'm sure @yosifkit probably feels similarly.) |
Aw bummer (wrt the tables). Does that require a feature request on the hub, or is it the same package as is used for the Docker docs? Wrt maintaining the list; I'm still +1 on having a list somewhere; IMO an image that doesn't properly document what it offers isn't really useful. I've mentioned this before, but would it be easier to add a link to the README that links to a markdown document inside the "main" repository? That would at least solve the "table" issue. Additionally, it would make it easier to ask a contributor to update that document together with the PR if anything changes in the extensions. |
What @thaJeztah said :) I'll push a new commit that reverts the tables when I get a minute, assuming there's support for merging this in some form. |
Yeah, that'd have to be a feature request to the Hub. As far as I know, they don't use the same renderer as the docs. I'm not opposed to pushing the information into the php repo directly, I just want to make sure we're not fragmenting the documentation just for fragmentation's sake. 😄 |
Well, there only a limited amount the README could offer without becoming too lengthy. So adding separate docs is probably required at some stage. The question then becomes where? The main repo? The docs repo? |
I like this idea. It might get out of date, but still will be useful. Do we want to reiterate that the |
@yosifkit probably. I actually thought about doing so, but didn't for whatever reason. |
Happy to close it. I'm glad to have helped spur a more sustainable long-term solution. |
+1 awesome job on the new implementation |
Add 'debops.atd' documentation
This PR updates the docs to list which extensions are being built and how.