search

doctrine / orm

Doctrine Object Relational Mapper (ORM)
https://www.doctrine-project.org/projects/orm.html
MIT License
9.92k stars 2.51k forks source link

[Documentation] Removing "Doctrine Mapping Types" ... #11384

Closed ThomasLandauer closed 6 months ago

ThomasLandauer commented 6 months ago

... in favor of https://www.doctrine-project.org/projects/doctrine-dbal/en/3.8/reference/types.html#reference

Page: https://www.doctrine-project.org/projects/doctrine-orm/en/2.19/reference/basic-mapping.html#doctrine-mapping-types

As announced in https://github.com/doctrine/dbal/pull/6336#issuecomment-2003720361 , the goal is to remove this duplicated type information from ORM and replace it with a link to DBAL. The information here was outdated regarding bigint and json_array. Besides, the order was weird.

In https://github.com/doctrine/dbal/pull/6341 , I'm adding any detail which I'm deleting here to the DBAL.

TODO/Question: What's the syntax for adding a link to DBAL docs?

greg0ire commented 6 months ago

Regarding how to link, here is an example: https://github.com/doctrine/orm/blob/55c4845d5734bea5579424c2c2a7c5b97dbb4c60/docs/en/reference/configuration.rst?plain=1#L90

ThomasLandauer commented 6 months ago

OK, thanks, I'm done for now :-)

greg0ire commented 6 months ago

Please kindly squash your commits together. If you don't, we'll try to remember to do it for you but it's best if you save us this trouble.

How to do that?

  1. git rebase -i origin/2.19.x, assuming origin is a git remote that points to this repository, and not your fork. If you're not sure what your remotes are, run git remote -vvv, there should be your fork and the holy/reference/base/origin/whatever-you-call-it repository.
  2. A window will show up with many lines, replace pick with fixup on every line but the first one
  3. Close your editor, git should do its magic, and you should end up with one commit
  4. Use git push --force to overwrite what you already push. Don't forget the --force option otherwise git will try to merge both things together.
ThomasLandauer commented 6 months ago

Well, looks like it worked - did it? If yes, then it went smoother than the last time you took me by the hand: https://github.com/doctrine/dbal/pull/4947#issuecomment-962433070 :-)

greg0ire commented 6 months ago

Yet it worked! Nice progress there :slightly_smiling_face: