Skip to content
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

Extensions/Membership: add MongoDB #3611

Closed
wants to merge 1 commit into from

Conversation

jrfnl
Copy link
Contributor

@jrfnl jrfnl commented Jul 25, 2024

Updates:

The MongoDB extension appears to be missing from the extension pages.

The build for this will fail due to the extension not having a book.xml page, but a set.xml page instead and the QA script not handling this. Should I rename the XML file ? Or submit an update for the QA script ?

Ref:

Verified

This commit was signed with the committer’s verified signature.
jrfnl Juliette
Updates:
* https://www.php.net/manual/en/extensions.alphabetical.php
* https://www.php.net/manual/en/extensions.membership.php

The MongoDB extension appears to be missing from the extension pages.

The build for this will fail due to the extension not having a `book.xml` page, but a `set.xml` page instead and the QA script not handling this.
Should I rename the XML file ? Or submit an update for the QA script ?

Ref:
* https://www.php.net/manual/en/set.mongodb.php
@cmb69
Copy link
Member

cmb69 commented Jul 25, 2024

Maybe @alcaeus or @jmikola can have a look at this?

@alcaeus
Copy link
Contributor

alcaeus commented Jul 25, 2024

I honestly don't know the difference between a book and a set, but if it's a simple case of renaming the XML file I think it's better to rename the file than to adapt the QA script.

@jrfnl
Copy link
Contributor Author

jrfnl commented Jul 25, 2024

I honestly don't know the difference between a book and a set

Maybe @bjori or @derickr can clarify ? They look to have been involved in the introduction of this extension handbook.

@cmb69
Copy link
Member

cmb69 commented Jul 25, 2024

Maybe @Girgias and @haszi are more into that nowadays.

@haszi
Copy link
Contributor

haszi commented Jul 25, 2024

I honestly don't know the difference between a book and a set

A book is a "complete book" and a set is a collection of books and is the top of the DocBook structural hierarchy (according to the official docs for book and set).
In practical terms, I think books are more useful for extension references as they can have multiple types of children elements (e.g appendices, chapters, references) while sets can only have articles, books and sets.

The build for this will fail due to the extension not having a book.xml page, but a set.xml page instead and the QA script not handling this. Should I rename the XML file ?

To add MongoDB to the list of extensions, changing set.xml to book.xml won't be enough unfortunately. The top <set> element needs to be converted to a <book>, its children <book> elements to <chapter>s, <article>s and <procedure>s to <section>s and probably some more deeper down the hierarchy. Also, at least some of the xml:ids need to be updated too.

I just checked and other than MongoDB, only MySQL is using a <set> instead of a <book> element as its top level element.

Should I rename the XML file ? Or submit an update for the QA script ?

My preference would be to update these two extensions' sets to books. If nobody has any objections, I can take a look at this this weekend.

What do you think @Girgias?

@php-pulls
Copy link

php-pulls commented Jul 25, 2024 via email

@php-pulls
Copy link

php-pulls commented Jul 25, 2024 via email

@cmb69
Copy link
Member

cmb69 commented Jul 25, 2024

Hey @php-pulls, you're still showing up as that, and not as @derickr. :)

@derickr
Copy link
Member

derickr commented Jul 25, 2024 via email

@Girgias
Copy link
Member

Girgias commented Jul 26, 2024

I am in favour of moving away from <set> and use <book>.

@alcaeus
Copy link
Contributor

alcaeus commented Jul 26, 2024

I think you should just leave fixing this to the mongodb folk, they keep these docs up to date.

That will take a while, as we currently have no bandwidth for larger changes to docs. If somebody else can and wants to handle this, it would be greatly appreciated!

@haszi
Copy link
Contributor

haszi commented Jul 28, 2024

I've opened a PR in doc-base (php/doc-base#138) and doc-en (#3627) to address this.

Please note that the changes made in the doc-en PR will have to be made in all translations too or they won't build once the doc-base PR is merged.

If needed, I can help with opening a PR in some of the translations. Since all of these changes are to the markup and to the xml:ids, this should not be a problem (hopefully).

@haszi
Copy link
Contributor

haszi commented Oct 26, 2024

@jrfnl The doc-base and documentation repository PRs have been merged.

@jrfnl
Copy link
Contributor Author

jrfnl commented Oct 27, 2024

Closing as fixed via the transformation of the MongoDB docs from a set to a book.

@jrfnl jrfnl closed this Oct 27, 2024
@jrfnl jrfnl deleted the feature/extensions-mongodb branch October 27, 2024 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants