DOCSP-45170: Landing page and cleanup

.github/workflows/add-netlify-links.yml

@@ -26,7 +26,7 @@ jobs:
           CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         run: |
           new_links=""
-          base_link='https://deploy-preview-${{ github.event.number }}--mongodb-docs-ruby.netlify.app'
+          base_link='https://deploy-preview-${{ github.event.number }}--docs-ruby.netlify.app'
           files=$(echo "$CHANGED_FILES" | tr "," "\n")
           for file in $files; do
             echo "processing ${file}"

snooty.toml

@@ -1,4 +1,20 @@
 name = "ruby-driver"
 title = "Ruby MongoDB Driver"
+toc_landing_pages = ["/connect"]
 
 intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
+sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
+
+[constants]
+driver-short = "Ruby driver"
+driver-long = "MongoDB Ruby Driver"
+language = "Ruby"
+mdb-server = "MongoDB Server"
+mongo-community = "MongoDB Community Edition"
+mongo-enterprise = "MongoDB Enterprise Edition"
+docs-branch = "master"                                            # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
+version-number = "2.21"
+patch-version-number = "{+version-number+}.0"                     # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
+version = "v{+version-number+}"
+stable-api = "Stable API"
+api-root = "https://www.mongodb.com/docs/ruby-driver/current/api"

source/index.txt

@@ -1,67 +1,119 @@
-.. http://www.mongodb.org/display/DOCS/Ruby+Language+Center
+====================
+{+driver-long+}
+====================
 
-.. _ruby-language-center:
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: twocols
 
-*******************
-Ruby MongoDB Driver
-*******************
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   View the Source <https://github.com/mongodb/mongo-ruby-driver>
+   API Documentation <{+api-root+}>
 
-.. default-domain:: mongodb
+.. TODO:
+ Get Started </get-started>
+ Connect </connect>
+ Databases & Collections </databases-collections>
+ Read Data </read>
+ Write Data </write>
+ Operations on Replica Sets </read-write-pref>
+ Indexes </indexes>
+ Monitor Your Application </monitoring>
+ Data Aggregation </aggregation>
+ Security </security>
+ Issues & Help </issues-and-help>
+ What's New </whats-new>
+ Upgrade </upgrade>
+ Compatibility </compatibility>
 
-.. class:: hidden
+Introduction
+------------
 
-  .. toctree::
-    :titlesonly:
+Welcome to the documentation site for the {+driver-long+}, the official
+MongoDB driver for {+language+} applications.
 
-    Get Started <getting-started>
-    Tutorials <tutorials>
-    Connection & Configuration <reference/connection-and-configuration>
-    Working with Data <reference/working-with-data>
-    Schema Operations <reference/schema-operations>
-    API <https://mongodb.com/docs/ruby-driver/current/api/>
-    Release Notes <release-notes>
-    Additional Resources <reference/additional-resources>
-    Contribute <contribute>
+.. TODO:
+.. Get Started
+.. -----------
 
-Welcome to the documentation site for the official MongoDB Ruby driver.
-You can add the driver to your application to work with MongoDB in
-Ruby.
+.. Learn how to install the driver, establish a connection to MongoDB, and begin
+.. working with data in the :ref:`ruby-get-started` tutorial.
 
-Get Started
-===========
+.. Connect to MongoDB
+.. ------------------
 
-To get started with the Ruby driver, see :doc:`/installation` and
-:doc:`/tutorials/quick-start`. Continue to :doc:`/tutorials`
-for high level documentation for common operations.
+.. Learn how to create and configure a connection to a MongoDB deployment
+.. in the :ref:`ruby-connect` section.
 
-BSON
-====
+.. Databases and Collections
+.. -------------------------
 
-The Ruby BSON implementation is packaged in a separate gem with C and
-Java extensions for speed depending on the runtime environment.
+.. Learn how to use the {+driver-short+} to work with MongoDB databases and collections in the
+.. :ref:`ruby-databases-collections` section.
 
-For reference on the Ruby BSON gem, see the :doc:`/tutorials/bson`.
+.. Read Data from MongoDB
+.. ----------------------
 
-Object Mappers
-==============
+.. Learn how you can retrieve data from MongoDB in the :ref:`ruby-read` section.
 
-Because MongoDB is so easy to use, the basic Ruby driver can be the
-best solution for many applications. But if you need validations,
-associations, and other high-level data modeling functions, then you
-may need Object Document Mapper.
+.. Write Data to MongoDB
+.. ---------------------
 
-In the context of a Rails application, an Object Document Mapper
-provides functionality equivalent to, but distinct from, ActiveRecord.
-Because MongoDB is a document-based database, these mappers are called
-Object Document Mappers (ODM) as opposed to Object Relational Mappers
-(ORM).
+.. Learn how you can write data to MongoDB in the :ref:`ruby-write` section.
 
-The ODM officially supported by MongoDB is Mongoid, originally written
-by Durran Jordan.
+.. Configure Operations on Replica Sets
+.. ------------------------------------
 
-For tutorials on Mongoid, see the `Mongoid Manual <https://mongodb.com/docs/mongoid/master>`_.
+.. Learn how to configure read and write operations on a replica set in the
+.. :ref:`ruby-read-write-pref` section.
 
-.. COMMENT  For the actual build, see mongodb/docs-ruby repo which pulls the documentation source from:
-..    mongo-ruby-driver,
-..    bson-ruby, and
-..    mongoid repos.
+.. Optimize Queries by Using Indexes
+.. ---------------------------------
+
+.. Learn how to work with common types of indexes in the :ref:`ruby-indexes`
+.. section.
+
+.. Transform Your Data with Aggregation
+.. ------------------------------------
+
+.. Learn how to use the {+driver-short+} to perform aggregation operations in the
+.. :ref:`ruby-aggregation` section.
+
+.. Secure Your Data
+.. ----------------
+
+.. Learn how to authenticate your application and encrypt your data in the
+.. :ref:`ruby-security` section.
+
+.. What's New
+.. ----------
+
+.. For a list of new features and changes in each version, see the :ref:`What's New <ruby-whats-new>`
+.. section.
+
+.. Upgrade Driver Versions
+.. -----------------------
+
+.. Learn what changes you must make to your application to upgrade driver
+.. versions in the :ref:`ruby-upgrade` section.
+
+.. Compatibility
+.. -------------
+
+.. To learn about the versions of the {+mdb-server+} and the {+language+} language
+.. that are compatible with  each version of the {+driver-short+}, see the
+.. :ref:`Compatibility <ruby-compatibility>` section.
+
+Developer Hub
+-------------
+
+The Developer Hub provides tutorials and social engagement for
+developers.
+
+To ask questions and engage in discussions with fellow developers who
+use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/ruby>`__.