diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml new file mode 100644 index 00000000..971e8a65 --- /dev/null +++ b/.github/workflows/backport.yml @@ -0,0 +1,26 @@ +name: Backport +on: + pull_request_target: + types: + - closed + - labeled + +jobs: + backport: + name: Backport + runs-on: ubuntu-latest + # Only react to merged PRs for security reasons. + # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target. + if: > + github.event.pull_request.merged + && ( + github.event.action == 'closed' + || ( + github.event.action == 'labeled' + && contains(github.event.label.name, 'backport') + ) + ) + steps: + - uses: tibdex/backport@v2 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/source/fundamentals.txt b/source/fundamentals.txt index a44f2708..9ea37b6c 100644 --- a/source/fundamentals.txt +++ b/source/fundamentals.txt @@ -8,23 +8,23 @@ Fundamentals :titlesonly: :maxdepth: 1 - /fundamentals/connection - /fundamentals/auth - /fundamentals/enterprise-auth - /fundamentals/stable-api - /fundamentals/databases-collections - /fundamentals/data-formats - /fundamentals/crud - /fundamentals/builders - /fundamentals/aggregation - /fundamentals/aggregation-expression-operations - /fundamentals/indexes - /fundamentals/transactions - /fundamentals/collations - /fundamentals/logging - /fundamentals/monitoring - /fundamentals/time-series - /fundamentals/encrypt-fields + Connection Guide + Authentication + Enterprise Authentication + Stable API + Databases & Collections + Data Formats + CRUD Operations /fundamentals/crud + Builders + Aggregation + Aggregation Expressions + Indexes + Transactions + Collations + Logging + Monitoring + Time Series Collections + In-Use Encryption .. TODO : add back in after MVP .. /fundamentals/gridfs diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index 4660b942..7bd54273 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -6,12 +6,12 @@ Builders .. toctree:: - /fundamentals/builders/aggregates - /fundamentals/builders/filters - /fundamentals/builders/indexes - /fundamentals/builders/projections - /fundamentals/builders/sort - /fundamentals/builders/updates + Aggregation + Filters + Indexes + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/fundamentals/connection.txt b/source/fundamentals/connection.txt index 5c8de999..8aed7e10 100644 --- a/source/fundamentals/connection.txt +++ b/source/fundamentals/connection.txt @@ -6,12 +6,12 @@ Connection Guide .. toctree:: - /fundamentals/connection/connect - /fundamentals/connection/connection-options - /fundamentals/connection/mongoclientsettings - /fundamentals/connection/network-compression - /fundamentals/connection/tls - /fundamentals/connection/socks5 + Connect to MongoDB + Connection Options + MongoClient Settings + Network Compression + TLS/SSL + SOCKS5 Proxy Connection .. contents:: On this page :local: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt index 80eb72ab..ea152d08 100644 --- a/source/fundamentals/crud.txt +++ b/source/fundamentals/crud.txt @@ -7,10 +7,10 @@ CRUD Operations .. toctree:: :caption: CRUD Operations - /fundamentals/crud/read-operations - /fundamentals/crud/write-operations - /fundamentals/crud/query-document - /fundamentals/crud/compound-operations + Read + Write + Query + Compound Operations CRUD (Create, Read, Update, Delete) operations enable you to work with data stored in MongoDB. diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt index 03036c47..5737e098 100644 --- a/source/fundamentals/data-formats.txt +++ b/source/fundamentals/data-formats.txt @@ -2,19 +2,19 @@ Data Formats ============ +.. toctree:: + :caption: Data Formats + + Data Classes + BSON + Extended JSON + Documents + Kotlin Serialization + Codecs + - :doc:`/fundamentals/data-formats/document-data-format-data-class` - :doc:`/fundamentals/data-formats/document-data-format-bson` - :doc:`/fundamentals/data-formats/document-data-format-extended-json` - :doc:`/fundamentals/data-formats/documents` - :doc:`/fundamentals/data-formats/serialization` - :doc:`/fundamentals/data-formats/codecs` - -.. toctree:: - :caption: Data Formats - - /fundamentals/data-formats/document-data-format-data-class - /fundamentals/data-formats/document-data-format-bson - /fundamentals/data-formats/document-data-format-extended-json - /fundamentals/data-formats/documents - /fundamentals/data-formats/serialization - /fundamentals/data-formats/codecs diff --git a/source/index.txt b/source/index.txt index 1baaa6f8..7cc0269a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -7,16 +7,16 @@ MongoDB Kotlin Driver :maxdepth: 1 Quick Start - /quick-reference - /whats-new - /usage-examples - /fundamentals - /api-documentation - /faq - /connection-troubleshooting - /issues-and-help - /compatibility - /migrate-kmongo + Quick Reference + What's New + Usage Examples + Fundamentals + API Documentation + FAQ + Connection Troubleshooting + Issues & Help + Compatibility + Migrate from KMongo View the Source Introduction diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 1e3844c2..56cb08d2 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -10,16 +10,15 @@ Usage Examples .. toctree:: - /usage-examples/find-operations - /usage-examples/insert-operations - /usage-examples/update-operations - /usage-examples/delete-operations - /usage-examples/bulkWrite - /usage-examples/watch - /usage-examples/count - /usage-examples/distinct - /usage-examples/command - + Find + Insert + Update & Replaces + Delete + Bulk Operations + Watch for Changes + Count Documents + Distinct Field Values + Run a Command Overview -------- diff --git a/source/usage-examples/delete-operations.txt b/source/usage-examples/delete-operations.txt index dc6f748e..f1574e01 100644 --- a/source/usage-examples/delete-operations.txt +++ b/source/usage-examples/delete-operations.txt @@ -2,12 +2,12 @@ Delete Operations ================= -- :doc:`Delete a Document ` -- :doc:`Delete Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/deleteOne - /usage-examples/deleteMany + Delete One + Delete Many + +- :doc:`Delete a Document ` +- :doc:`Delete Multiple Documents ` \ No newline at end of file diff --git a/source/usage-examples/find-operations.txt b/source/usage-examples/find-operations.txt index faa91153..17d2f6d8 100644 --- a/source/usage-examples/find-operations.txt +++ b/source/usage-examples/find-operations.txt @@ -2,11 +2,11 @@ Find Operations =============== -- :doc:`Find a Document ` -- :doc:`Find Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/findOne - /usage-examples/find + Find One + Find Many + +- :doc:`Find a Document ` +- :doc:`Find Multiple Documents ` diff --git a/source/usage-examples/insert-operations.txt b/source/usage-examples/insert-operations.txt index 05005b02..74fe1d7a 100644 --- a/source/usage-examples/insert-operations.txt +++ b/source/usage-examples/insert-operations.txt @@ -2,11 +2,11 @@ Insert Operations ================= -- :doc:`Insert a Document ` -- :doc:`Insert Multiple Documents ` - .. toctree:: :caption: Examples - /usage-examples/insertOne - /usage-examples/insertMany + Insert One + Insert Many + +- :doc:`Insert a Document ` +- :doc:`Insert Multiple Documents ` diff --git a/source/usage-examples/update-operations.txt b/source/usage-examples/update-operations.txt index 802aefff..0513e947 100644 --- a/source/usage-examples/update-operations.txt +++ b/source/usage-examples/update-operations.txt @@ -2,13 +2,13 @@ Update & Replace Operations =========================== -- :doc:`Update a Document ` -- :doc:`Update Multiple Documents ` -- :doc:`Replace a Document ` - .. toctree:: :caption: Examples - /usage-examples/updateOne - /usage-examples/updateMany - /usage-examples/replaceOne + Update One + Update Many + Replace One + +- :doc:`Update a Document ` +- :doc:`Update Multiple Documents ` +- :doc:`Replace a Document `