From e00d5fb4e5a5ee823c88e1599fb9a12fd2ef1848 Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Wed, 22 Jan 2025 10:31:07 -0800 Subject: [PATCH 1/3] add additional resources page --- source/additional-resources.txt | 61 -------- source/ecosystem.txt | 84 ----------- source/integrations-tools.txt | 4 +- .../integrations-tools/external-resources.txt | 132 ++++++++++++++++++ 4 files changed, 133 insertions(+), 148 deletions(-) delete mode 100644 source/additional-resources.txt delete mode 100644 source/ecosystem.txt create mode 100644 source/integrations-tools/external-resources.txt diff --git a/source/additional-resources.txt b/source/additional-resources.txt deleted file mode 100644 index 065b8ee..0000000 --- a/source/additional-resources.txt +++ /dev/null @@ -1,61 +0,0 @@ -******************** -Additional Resources -******************** - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -This page lists some of the third-party guides and blog posts about Mongoid, -as well as sample Mongoid applications. Additional resources for the driver -are listed on the `respective driver page -`_. - - -Screencasts -=========== - -- `RailsCasts: Mongoid (revised) - `_ - - An overview of Mongoid, by Ryan Bates including the basics - of setting up an app, querying for documents, adding embedded - associations, overriding the id, and more. - -- `{+ror+} Web Services and Integration with MongoDB, Week 3: Mongoid - `_ - - A detailed introduction to Mongoid and {+ror+} web services. - -- `Create a search bar in Rails with Mongoid - `_ - - A Tutorial explaining how to implement text search with Mongoid. - - -Articles -======== - -- `A Simple Content Management System in Sinatra `_ - - Building a content management application with Sinatra and Mongoid. - -- `How To Create A Ruby API With Sinatra `_ - - Creating a Sinatra API with Mongoid. - -- `Converting an existing {+ror+} application to MongoDB `_ - - How to Convert an existing {+ror+} application to use MongoDB and Mongoid. - - -Sample Applications -=================== - -- `Mongoid Demo `_ - - A repository containing sample applications using Mongoid. diff --git a/source/ecosystem.txt b/source/ecosystem.txt deleted file mode 100644 index 9d89cc7..0000000 --- a/source/ecosystem.txt +++ /dev/null @@ -1,84 +0,0 @@ -********* -Ecosystem -********* - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 2 - :class: singlecol - -Mongoid has an extensive ecosystem of libraries integrating with or built -on top of Mongoid, are listed below. - - -Projects -======== - -- `Workarea Commerce `_ - - Workarea is an enterprise-grade {+ror+} commerce platform that uses Mongoid. - - -Extension Libraries -=================== - -- `Mongoid Tree `_ - - A tree structure for Mongoid documents using the materialized path pattern. - -- `Mongoid Token `_ - - A little random, unique token generator for Mongoid documents. - -- `Mongoid Collection Snapshot `_ - - Easy maintenance of collections of processed data in MongoDB with the Mongoid ODM. - -- `Mongoid Locker `_ - - Document-level locking for MongoDB via Mongoid. - -- `Mongo Beautiful Logger `_ - - A simple and beautiful logger library for MongoDB in your Ruby/Rails app. - -- `Mongoid Search `_ - - Simple full text search for Mongoid. - -- `Mongoid Fulltext Search `_ - - Full-text search using n-gram matching for the Mongoid ODM. - - -Integration Libraries -===================== - -- `CarrierWave Mongoid `_ - - Mongoid Support for the Carrierwave file uploads library. - -- `Mongoid RSpec `_ - - RSpec matchers and macros for Mongoid applications. - -- `RailsAdmin `_ supports Mongoid out - of the box. - -- `ActiveAdmin Mongoid `_ - - ActiveAdmin hacks to support Mongoid. - -- `Mongoid History `_ - - Multi-user non-linear history tracking, auditing, undo, redo for mongoid. -- `Delayed Job Mongoid `_ - - Mongoid backend for delayed_job. - -- `Mongo Session Store `_ - - A Rails-compatible session store for Mongoid. diff --git a/source/integrations-tools.txt b/source/integrations-tools.txt index 6def4a4..bd7b09e 100644 --- a/source/integrations-tools.txt +++ b/source/integrations-tools.txt @@ -16,6 +16,4 @@ Integrations & Tools Add {+odm+} to an Existing Application Rails Integration - -.. TODO -.. External Libraries + External Libraries diff --git a/source/integrations-tools/external-resources.txt b/source/integrations-tools/external-resources.txt new file mode 100644 index 0000000..67fdb16 --- /dev/null +++ b/source/integrations-tools/external-resources.txt @@ -0,0 +1,132 @@ +.. _mongoid-external-resources: + +================== +External Resources +================== + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: mongoid, ruby, libraries, ecosystem, tools + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +Overview +-------- + +In this guide, you can learn about the external resources you can use to learn +more about {+odm+}, and tools you can use to enhance your {+odm+} applications. + +Projects and Libraries +---------------------- + +The following sections describe projects and libraries that are integrated with +or built on top of {+odm+}. + +Projects +~~~~~~~~ + +- `Workarea Commerce `__ is an + enterprise-grade {+ror+} commerce platform that uses {+odm+}. + +Extension Libraries +~~~~~~~~~~~~~~~~~~~ + +- `Mongoid Tree `__ is a tree structure + for {+odm+} documents that uses the materialized path pattern. + +- `Mongoid Token `__ is a random, + unique token generator for {+odm+} documents. + +- `Mongoid Collection Snapshot + `__ helps maintain + collections of processed data in {+odm+} applications. + +- `Mongoid Locker `__ provides + document-level locking for {+odm+} applications. + +- `Mongo Beautiful Logger + `__ is a library that + formats your MongoDB logs. + +- `Mongoid Search `__ provides + full-text search for {+odm+}. + +- `Mongoid Fulltext Search `__ + provides full-text search using n-gram matching for {+odm+}. + +Integration Libraries +~~~~~~~~~~~~~~~~~~~~~ + +- `CarrierWave Mongoid + `__ provides + {+odm+} support for the Carrierwave file uploads library. + +- `Mongoid RSpec `__ provide RSpec + matchers and macros for {+odm+} applications. + +- `RailsAdmin `__ is a Rails engine that + provides an interface for managing your data. + +- `ActiveAdmin Mongoid `__ + ActiveAdmin hacks to support {+odm+}. + +- `Mongoid History `__ is a + multi-user, non-linear history tracker for {+odm+}. + +- `Delayed Job Mongoid + `__ is a {+odm+} backend for + ``delayed_job``. + +- `Mongo Session Store `__ is a + Rails-compatible session store for {+odm+}. + +Learning Resources +------------------ + +The following sections provide screencasts, articles, and sample +applications that you can use to learn more about {+odm+}. + +Screencasts +~~~~~~~~~~~ + +- `RailsCasts: Mongoid (revised) + `__ gives an overview of {+odm+}, + by Ryan Bates. It includes the basics + of setting up an app, querying for documents, adding embedded + associations, overriding the ID, and more. + +- `{+ror+} Web Services and Integration with MongoDB, Week 3: Mongoid + `__ provides a detailed + introduction to {+odm+} and {+ror+} web services. + +- `Create a search bar in Rails with Mongoid + `__ is a tutorial that explains how + to implement text search with {+odm+}. + +Articles +~~~~~~~~ + +- `A Simple Content Management System in Sinatra + `__: + Building a content management application with Sinatra and {+odm+}. + +- `How To Create A Ruby API With Sinatra + `__: Creating a + Sinatra API with {+odm+}. + +- `Converting an existing {+ror+} application to MongoDB + `__: Learn how to Convert an + existing {+ror+} application to use MongoDB and {+odm+}. + +Sample Applications +~~~~~~~~~~~~~~~~~~~ + +- `Mongoid Demo `__: A repository + containing sample applications that use {+odm+}. \ No newline at end of file From a6666001b3a82d966f133392fd7c92dcefd9572f Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Wed, 22 Jan 2025 10:51:10 -0800 Subject: [PATCH 2/3] edits --- source/integrations-tools.txt | 2 +- source/integrations-tools/external-resources.txt | 14 +++++--------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/source/integrations-tools.txt b/source/integrations-tools.txt index bd7b09e..0e5110d 100644 --- a/source/integrations-tools.txt +++ b/source/integrations-tools.txt @@ -16,4 +16,4 @@ Integrations & Tools Add {+odm+} to an Existing Application Rails Integration - External Libraries + External Resources diff --git a/source/integrations-tools/external-resources.txt b/source/integrations-tools/external-resources.txt index 67fdb16..4499c17 100644 --- a/source/integrations-tools/external-resources.txt +++ b/source/integrations-tools/external-resources.txt @@ -20,8 +20,9 @@ External Resources Overview -------- -In this guide, you can learn about the external resources you can use to learn -more about {+odm+}, and tools you can use to enhance your {+odm+} applications. +In this guide, you can find external tools and resources that you can use to +enhance your {+odm+} applications. These resources include external projects and +libraries, and various learning resources. Projects and Libraries ---------------------- @@ -66,7 +67,7 @@ Integration Libraries - `CarrierWave Mongoid `__ provides - {+odm+} support for the Carrierwave file uploads library. + {+odm+} support for the Carrierwave file-uploads library. - `Mongoid RSpec `__ provide RSpec matchers and macros for {+odm+} applications. @@ -99,12 +100,7 @@ Screencasts - `RailsCasts: Mongoid (revised) `__ gives an overview of {+odm+}, by Ryan Bates. It includes the basics - of setting up an app, querying for documents, adding embedded - associations, overriding the ID, and more. - -- `{+ror+} Web Services and Integration with MongoDB, Week 3: Mongoid - `__ provides a detailed - introduction to {+odm+} and {+ror+} web services. + of setting up an application and working with data. - `Create a search bar in Rails with Mongoid `__ is a tutorial that explains how From 80d359fd20a75a8918dabae2cab578b2399692b8 Mon Sep 17 00:00:00 2001 From: Jordan Smith Date: Wed, 22 Jan 2025 11:46:31 -0800 Subject: [PATCH 3/3] feedback --- .../integrations-tools/external-resources.txt | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/source/integrations-tools/external-resources.txt b/source/integrations-tools/external-resources.txt index 4499c17..2099409 100644 --- a/source/integrations-tools/external-resources.txt +++ b/source/integrations-tools/external-resources.txt @@ -42,8 +42,8 @@ Extension Libraries - `Mongoid Tree `__ is a tree structure for {+odm+} documents that uses the materialized path pattern. -- `Mongoid Token `__ is a random, - unique token generator for {+odm+} documents. +- `Mongoid Token `__ generates random, + tokens for {+odm+} documents. - `Mongoid Collection Snapshot `__ helps maintain @@ -69,14 +69,14 @@ Integration Libraries `__ provides {+odm+} support for the Carrierwave file-uploads library. -- `Mongoid RSpec `__ provide RSpec +- `Mongoid RSpec `__ provides RSpec matchers and macros for {+odm+} applications. - `RailsAdmin `__ is a Rails engine that provides an interface for managing your data. - `ActiveAdmin Mongoid `__ - ActiveAdmin hacks to support {+odm+}. + provides ActiveAdmin hacks to support {+odm+}. - `Mongoid History `__ is a multi-user, non-linear history tracker for {+odm+}. @@ -97,10 +97,9 @@ applications that you can use to learn more about {+odm+}. Screencasts ~~~~~~~~~~~ -- `RailsCasts: Mongoid (revised) - `__ gives an overview of {+odm+}, - by Ryan Bates. It includes the basics - of setting up an application and working with data. +- `RailsCasts: Mongoid (revised) with Ryan Bates + `__ gives an overview of {+odm+}. + It includes the basics of setting up an application and working with data. - `Create a search bar in Rails with Mongoid `__ is a tutorial that explains how @@ -118,7 +117,7 @@ Articles Sinatra API with {+odm+}. - `Converting an existing {+ror+} application to MongoDB - `__: Learn how to Convert an + `__: Learn how to convert an existing {+ror+} application to use MongoDB and {+odm+}. Sample Applications