From 2ac67b90eb8c2697f5f9bba86c9ebde1687bb0ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= <jerome@tamarelle.net>
Date: Tue, 14 May 2024 12:30:46 +0200
Subject: [PATCH 1/2] Add docs for GridFS adapter

---
 _data/menu_v2.yml      |  1 +
 docs/adapter/gridfs.md | 67 ++++++++++++++++++++++++++++++++++++++++++
 docs/index.md          |  1 +
 3 files changed, 69 insertions(+)
 create mode 100644 docs/adapter/gridfs.md

diff --git a/_data/menu_v2.yml b/_data/menu_v2.yml
index 86ff7a3f1..ccf34be78 100644
--- a/_data/menu_v2.yml
+++ b/_data/menu_v2.yml
@@ -26,6 +26,7 @@ Official Adapters:
     AsyncAws S3: '/docs/adapter/async-aws-s3/'
     Azure Blob Storage: '/docs/adapter/azure-blob-storage/'
     Google Cloud Storage: '/docs/adapter/google-cloud-storage/'
+    MongoDB GridFS: '/docs/adapter/mongodb-gridfs/'
     SFTP (V2): '/docs/adapter/sftp-v2/'
     SFTP (V3): '/docs/adapter/sftp-v3/'
     WebDAV: '/docs/adapter/webdav/'
diff --git a/docs/adapter/gridfs.md b/docs/adapter/gridfs.md
new file mode 100644
index 000000000..3fffa4508
--- /dev/null
+++ b/docs/adapter/gridfs.md
@@ -0,0 +1,67 @@
+---
+layout: default
+title: MongoDB GridFS Adapter
+permalink: /docs/adapter/gridfs/
+redirect_from: /v2/docs/adapter/gridfs/
+---
+
+## Installation
+
+```bash
+composer require league/flysystem-gridfs:^3.0
+```
+
+## About
+
+Interacting with MongoDB GridFS through Flysystem can be done
+by using the `League\Flysystem\GridFS\GridFSAdapter`.
+
+Read more about the MongoDB PHP Library in the [official documentation](https://www.mongodb.com/docs/php-library/).
+
+## Simple usage:
+
+```php
+$client = new MongoDB\Client('mongodb://localhost:27017/');
+
+// The internal adapter
+$adapter = new League\Flysystem\GridFS\GridFSAdapter(
+    // GridFS Bucket
+    $client->selectDatabase('flysystem')->selectGridFSBucket()
+);
+
+// The FilesystemOperator
+$filesystem = new League\Flysystem\Filesystem($adapter);
+```
+
+## Advanced usage:
+
+```php
+$client = new MongoDB\Client('mongodb://localhost:27017/');
+
+// The internal adapter
+$adapter = new League\Flysystem\GridFS\GridFSAdapter(
+    // GridFS Bucket
+    $client->selectDatabase('flysystem')->selectGridFSBucket([
+        // Bucket name in the MongoDB database
+        'bucketName' => 'project_files'
+    ])
+    // Optional path prefix
+    'path/prefix',
+);
+
+// The FilesystemOperator
+$filesystem = new League\Flysystem\Filesystem($adapter);
+```
+
+## Versioning:
+
+In GridFS, file names are metadata to file objects identified by unique MongoDB `ObjectID`.
+There may be more than one file with the same name, they are called "revisions":
+- Reading a file reads the last revision of this file name
+- Writing to a file name creates a new revision for this file name
+- Renaming a file renames all the revisions of this file name
+- Deleting a file deletes all the revisions of this file name
+
+The GridFS Adapter for Flysystem does not provide access to a specific revision of a filename,
+you must use the [GridFS API](https://www.mongodb.com/docs/php-library/current/tutorial/gridfs/)
+if you need to work with revisions.
diff --git a/docs/index.md b/docs/index.md
index 71e91b92c..86d8fab1b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -40,6 +40,7 @@ for which ever storage is right for you.
 * **[AsyncAws S3](/docs/adapter/async-aws-s3/)**
 * **[Google Cloud Storage](/docs/adapter/google-cloud-storage/)**
 * **[Azure Blob Storage](/docs/adapter/azure-blob-storage/)**
+* **[MongoDB GridFS](/docs/adapter/mongodb-gridfs/)**
 * **[WebDAV](/docs/adapter/webdav/)**
 
 ### Third party Adapters

From e5c3c4608836d18c9b082d5c3acccce6f7c4a59e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= <jerome@tamarelle.net>
Date: Wed, 22 May 2024 07:31:43 +0200
Subject: [PATCH 2/2] Update menu_v2.yml

---
 _data/menu_v2.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/_data/menu_v2.yml b/_data/menu_v2.yml
index ccf34be78..b1d937ed0 100644
--- a/_data/menu_v2.yml
+++ b/_data/menu_v2.yml
@@ -26,7 +26,7 @@ Official Adapters:
     AsyncAws S3: '/docs/adapter/async-aws-s3/'
     Azure Blob Storage: '/docs/adapter/azure-blob-storage/'
     Google Cloud Storage: '/docs/adapter/google-cloud-storage/'
-    MongoDB GridFS: '/docs/adapter/mongodb-gridfs/'
+    MongoDB GridFS: '/docs/adapter/gridfs/'
     SFTP (V2): '/docs/adapter/sftp-v2/'
     SFTP (V3): '/docs/adapter/sftp-v3/'
     WebDAV: '/docs/adapter/webdav/'