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

Convert MongoDB documentation from a top element of set to book #3627

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

haszi
Copy link
Contributor

@haszi haszi commented Jul 28, 2024

Convert all underlying elements as needed:

  • <books> to <part>s or <chapter>s
  • <article>s to <section>s

Move the Predefined Constants page from the Installing/Configuring section to its own

Change the following xml:ids:

  • book.mongodb to mongodb.mongodb
  • set.mongodb to book.mongodb
  • book.bson to mongodb.bson

Please note that these changes only work when the accompanying doc-base changes are merged too (php/doc-base#138).

Note:
Please note that because of the difference between root chunks and container chunks in PhD (ie. a <book> and a <part>), the four pages linked to from the main MongoDB page (MongoDB, BSON, Monitoring and Exceptions) are only going to list their underlying classes without listing each method of each class.
E.g. the MongoDB Extension Classes page will only list the 19 classes belonging to that group of classes instead of listing the 19 classes plus all their 144 methods. As before, the methods are still listed on the pages of their respective classes.

@haszi haszi force-pushed the Convert-MongoDB-from-set-to-book branch 2 times, most recently from 30cee85 to 4469436 Compare July 28, 2024 13:06
@haszi
Copy link
Contributor Author

haszi commented Jul 28, 2024

This PR is now ready for review. The build failure is due to this PR only working in tandem with the accompanying doc-base PR (php/doc-base#138) as the overall hierarchy of the manual is defined in doc-base.

@cmb69
Copy link
Member

cmb69 commented Jul 30, 2024

Thank you!

This appears to be a very reasonable change to me, and I think it's okay for translations to catch up with this soon (given that the required changes are kept within bounds).

So, in my opinion, this is good to go.

Copy link
Member

@Girgias Girgias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable to me and not that hard to update.

haszi added 3 commits September 28, 2024 17:25
Convert all underlying elements as needed:
 - books to parts or chapters
 - articles to sections

Move the Predefined Constants page from the Installing/Configuring section to its own

Change the following xml:ids:
 - book.mongodb to mongodb.mongodb
 - set.mongodb to book.mongodb
 - book.bson to mongodb.bson
@haszi haszi force-pushed the Convert-MongoDB-from-set-to-book branch from 4469436 to 46f531d Compare September 28, 2024 15:26
@haszi
Copy link
Contributor Author

haszi commented Sep 28, 2024

Please advise whether we can move forward with this and the doc-base PR or if I need to make any changes to this PR.

If this gets merged, I can open a PR with the same changes in some/all of the translation repos.

Copy link
Member

@cmb69 cmb69 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine for me!

Maybe @alcaeus and @jmikola want to have a look, though.

@alcaeus
Copy link
Contributor

alcaeus commented Sep 30, 2024

Current set of changes LGTM! The build doesn't quite like it though ;)

@cmb69
Copy link
Member

cmb69 commented Sep 30, 2024

I think this just needs php/doc-base#138 to work.

@jmikola
Copy link
Member

jmikola commented Sep 30, 2024

No objections from my end. Thanks for taking this on @haszi.

Please note that because of the difference between root chunks and container chunks in PhD (ie. a <book> and a <part>), the four pages linked to from the main MongoDB page (MongoDB, BSON, Monitoring and Exceptions) are only going to list their underlying classes without listing each method of each class.

That will be a welcome improvement.

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.

5 participants