Skip to content

DOCSP-35932: compatibility page #2714

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 2, 2024
Merged

DOCSP-35932: compatibility page #2714

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2743bcc
DOCSP-35932: compatibility page
Jan 26, 2024
1f8956c
DOCSP-35932: compatibility page
Jan 26, 2024
5e6c7ac
add facet
Jan 26, 2024
b8482fa
add Laravel MongoDB v3.9 compatibility
Feb 1, 2024
5b36065
Merge branch '4.1' into DOCSP-35932-compatibility
Feb 1, 2024
27f88e0
remove last line
Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/compatibility.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _laravel-compatibility:

=============
Compatibility
=============

.. facet::
:name: genre
:values: reference

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Laravel Compatibility
---------------------

The following compatibility table specifies the versions of Laravel and
{+odm-short+} that you can use together.

.. include:: /includes/framework-compatibility-laravel.rst

To find compatibility information for unmaintained versions of {+odm-short+},
see `Laravel Version Compatibility <https://github.com/mongodb/laravel-mongodb/blob/3.9/README.md#installation>`__
on GitHub.
16 changes: 16 additions & 0 deletions docs/includes/framework-compatibility-laravel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. list-table::
:header-rows: 1
:stub-columns: 1

* - {+odm-short+} Version
- Laravel 10.x
- Laravel 9.x
Copy link
Contributor

Choose a reason for hiding this comment

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

Q: Is "9.x" here just for completeness? Or do we expect to use it in the future?

Copy link
Member

Choose a reason for hiding this comment

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

Not expected. I think it's for completeness because we didn't import the original table.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I included it for completeness since it's currently a supported version of Laravel, so users might wonder whether it is compatible.

Copy link
Member

Choose a reason for hiding this comment

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

You may add the first line of the table then.

9.x | 3.9.x | ❌

Copy link
Member

Choose a reason for hiding this comment

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

Then this doesn't tell which version is supported.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I interpreted this as 3.9.x is incompatible with 10.x, but is compatible with 9.x and added that row to the new table. Is that incorrect? Would you like me to keep/remove/change anything before merging?

Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I mean 3.9 is no longer maintained.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah ok, so if I understand correctly, we should also inform the reader which versions are maintained. Do you think it would be better to omit this line since there are several unmaintained versions of Laravel MongoDB prior to 3.9? Or if you want to keep it, I can add a line of text or footnote that mentions that 3.9 isn't maintained anymore. Let me know what works best for you, thanks.

Copy link
Member

Choose a reason for hiding this comment

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

Lets remove this last line then. We already have a link to the old versions table.


* - 4.1
- ✓
-

* - 4.0
- ✓
-

11 changes: 7 additions & 4 deletions docs/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Laravel MongoDB
/user-authentication
/queues
/transactions
/compatibility
/upgrade

Introduction
Expand All @@ -36,10 +37,6 @@ Laravel Eloquent and Query Builder syntax to work with your MongoDB data.
maintained by MongoDB, Inc. and is compatible with Laravel 10.x and
later.

To find versions of the package compatible with older versions of Laravel,
see `Laravel Version Compatibility <https://github.com/mongodb/laravel-mongodb/blob/3.9/README.md#installation>`__
on GitHub.

Getting Started
---------------

Expand All @@ -58,6 +55,12 @@ see the following content:
- :ref:`laravel-queues`
- :ref:`laravel-transactions`

Compatibility
-------------

To learn more about which versions of the {+odm-long+} and Laravel are
compatible, see the :ref:`laravel-compatibility` section.

Upgrade Versions
----------------

Expand Down