Merge pull request #36 from i80and/DOP-4809

DOP-4809: Inline the mongodb/mongoid docs submodule into this repository

Author: i80and

.gitmodules

@@ -0,0 +1 @@
+_build

mongoid

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

source/.gitignore

@@ -0,0 +1,14 @@
+Mongoid Documentation
+=================================
+
+This subdirectory contains the high-level driver documentation, including
+tutorials and the reference.
+
+To build the documentation locally for review, install `sphinx` and
+`sphinx-book-theme`, then execute `make html` in this directory:
+
+    pip install 'sphinx<4.3' sphinx-book-theme
+    make html
+
+Note: sphinx 4.3 is currently breaking when trying to render Mongoid
+documentation.

source/Makefile

@@ -0,0 +1,61 @@
+********************
+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
+<https://mongodb.com/docs/ruby-driver/current/reference/additional-resources/>`_.
+
+
+Screencasts
+===========
+
+- `RailsCasts: Mongoid (revised)
+  <https://www.youtube.com/watch?v=L0RqU2MdqXU>`_
+
+  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.
+
+- `Ruby on Rails Web Services and Integration with MongoDB, Week 3: Mongoid
+  <https://www.youtube.com/watch?v=9LylgiMYsUM>`_
+
+  A detailed introduction to Mongoid and Ruby on Rails web services.
+
+- `Create a search bar in Rails with Mongoid
+  <https://www.youtube.com/watch?v=zusWR8jS5-A>`_
+
+  A Tutorial explaining how to implement text search with Mongoid.
+
+
+Articles
+========
+
+- `A Simple Content Management System in Sinatra <https://www.sitepoint.com/a-simple-content-management-system-in-sinatra>`_
+
+  Building a content management application with Sinatra and Mongoid.
+
+- `How To Create A Ruby API With Sinatra <https://x-team.com/blog/how-to-create-a-ruby-api-with-sinatra>`_
+
+  Creating a Sinatra API with Mongoid.
+
+- `Converting an existing Ruby on Rails application to MongoDB <https://ibraheem.ca/posts/convert-rails-to-mongodb>`_
+
+  How to Convert an existing Ruby on Rails application to use MongoDB and Mongoid.
+
+
+Sample Applications
+===================
+
+- `Mongoid Demo <https://github.com/mongoid/mongoid-demo>`_
+
+  A repository containing sample applications using Mongoid.

source/README.md

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Mongoid'
+copyright = '2021, MongoDB'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+source_suffix = {
+    '.txt': 'restructuredtext',
+}
+
+html_theme = 'sphinx_book_theme'

source/additional-resources.txt

@@ -0,0 +1,21 @@
+.. _contributing:
+
+************
+Contributing
+************
+
+.. default-domain:: mongodb
+
+.. toctree::
+  :titlesonly:
+
+  contributing/code-documentation
+  contributing/contributing-guidelines
+
+Overview
+--------
+
+Learn how to contribute to the Mongoid repository in the following sections:
+
+- :ref:`Code Documentation <code-documentation>`
+- :ref:`Contributing Guidelines <contributing-guidelines>`