From f7f4c17668867c0d387ad3af255c156d0a0172f7 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 23 Sep 2024 16:20:56 -0400 Subject: [PATCH 1/5] DOCSP-42732: qs --- mongoid | 1 + snooty.toml | 2 ++ source/index.txt | 18 ++++++------- source/quick-start.txt | 57 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 9 deletions(-) create mode 160000 mongoid create mode 100644 source/quick-start.txt diff --git a/mongoid b/mongoid new file mode 160000 index 00000000..f493754d --- /dev/null +++ b/mongoid @@ -0,0 +1 @@ +Subproject commit f493754d1cd70f89f2d77ba977ca280c87672e79 diff --git a/snooty.toml b/snooty.toml index 9eb93a00..d44f174f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -6,3 +6,5 @@ intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"] [constants] rails-6-version = 6.0 rails-7-version = 7.1 +odm = "Mongoid" +ruby-driver = "Ruby driver" diff --git a/source/index.txt b/source/index.txt index 0f320dd5..91a3a1a2 100644 --- a/source/index.txt +++ b/source/index.txt @@ -1,18 +1,18 @@ -.. _mongoid: +.. _mongoid-odm: -******* -Mongoid -******* +======= +{+odm+} +======= -.. default-domain:: mongodb - -Mongoid is the officially supported object-document mapper (ODM) for MongoDB in -Ruby. To work with Mongoid from the command line using ``rails``-like tooling, -the `railsmdb `_ utility can be used. +{+odm+} is the officially supported object-document mapper (ODM) for +MongoDB in Ruby. To work with {+odm+} from the command line using +``rails``-like tooling, the `railsmdb +`_ utility can be used. .. toctree:: :titlesonly: + /quick-start installation-configuration tutorials schema-configuration diff --git a/source/quick-start.txt b/source/quick-start.txt new file mode 100644 index 00000000..ee56035a --- /dev/null +++ b/source/quick-start.txt @@ -0,0 +1,57 @@ +.. _mongoid-quick-start: + +=========== +Quick Start +=========== + +.. facet:: + :name: genre + :values: tutorial + +.. meta:: + :keywords: php framework, odm + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Overview +-------- + +This guide shows you how to use {+odm+} in a new web application, +connect to a MongoDB cluster hosted on MongoDB Atlas, and perform +read and write operations on the data. + +.. tip:: + + If you prefer to connect to MongoDB by using the {+ruby-driver+} without + {+odm+}, see the {+ruby-driver+} :driver:`Quick Start guide + `. + +{+odm+} is an Object-Document Mapper (ODM) framework for MongoDB in +Ruby. + +MongoDB Atlas is a fully managed cloud database service that hosts your +MongoDB deployments. You can create your own free (no credit card +required) MongoDB Atlas deployment by following the steps in this guide. + +Follow the steps in this guide to create a sample {+odm+} web application +that connects to a MongoDB deployment. + +.. TODO .. tip:: +.. +.. You can download the complete web application project by cloning the +.. `mongoid-quickstart <>`__ GitHub repository. + +.. toctree:: + + /quick-start/download-and-install/ + +.. /quick-start/create-a-deployment/ +.. /quick-start/create-a-connection-string/ +.. /quick-start/configure-mongodb/ +.. /quick-start/view-data/ +.. /quick-start/write-data/ +.. /quick-start/next-steps/ From 482cb67b7bdbbec3c17cfc3bfa52ddbe8ab1bb79 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 23 Sep 2024 16:23:15 -0400 Subject: [PATCH 2/5] fix --- .dockerignore | 2 -- mongoid | 1 - 2 files changed, 3 deletions(-) delete mode 100644 .dockerignore delete mode 160000 mongoid diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index c2c70813..00000000 --- a/.dockerignore +++ /dev/null @@ -1,2 +0,0 @@ -# Cannot dockerignore .git - giza insists on using git on the docs repo -/build diff --git a/mongoid b/mongoid deleted file mode 160000 index f493754d..00000000 --- a/mongoid +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f493754d1cd70f89f2d77ba977ca280c87672e79 From 891e0f2b843039cf8ed49bc4cec7657aec7af3f5 Mon Sep 17 00:00:00 2001 From: rustagir Date: Mon, 23 Sep 2024 16:28:31 -0400 Subject: [PATCH 3/5] wip --- snooty.toml | 8 +++++++- source/quick-start.txt | 4 ++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/snooty.toml b/snooty.toml index d44f174f..07458bfa 100644 --- a/snooty.toml +++ b/snooty.toml @@ -1,7 +1,13 @@ name = "mongoid" title = "Mongoid" -intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"] +intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv", + "https://www.mongodb.com/docs/atlas/objects.inv" + ] + +toc_landing_pages = [ + "/quick-start" + ] [constants] rails-6-version = 6.0 diff --git a/source/quick-start.txt b/source/quick-start.txt index ee56035a..724a2188 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -27,8 +27,8 @@ read and write operations on the data. .. tip:: If you prefer to connect to MongoDB by using the {+ruby-driver+} without - {+odm+}, see the {+ruby-driver+} :driver:`Quick Start guide - `. + {+odm+}, see the {+ruby-driver+} :ruby:`Quick Start guide + `. {+odm+} is an Object-Document Mapper (ODM) framework for MongoDB in Ruby. From 87689f28fd88d07c071d5b7597e091dee3cc1f66 Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 24 Sep 2024 10:12:05 -0400 Subject: [PATCH 4/5] remove action --- .github/workflows/check-autobuilder.yml | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 .github/workflows/check-autobuilder.yml diff --git a/.github/workflows/check-autobuilder.yml b/.github/workflows/check-autobuilder.yml deleted file mode 100644 index 7e15fe91..00000000 --- a/.github/workflows/check-autobuilder.yml +++ /dev/null @@ -1,13 +0,0 @@ -name: Check Autobuilder for Errors - -on: - pull_request: - paths: - - "source/**" - -jobs: - check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: cbush/snooty-autobuilder-check@main \ No newline at end of file From cfa5ff633210b6dde3732d67a3cc31e4b88ca75b Mon Sep 17 00:00:00 2001 From: rustagir Date: Wed, 25 Sep 2024 15:39:28 -0400 Subject: [PATCH 5/5] NR suggestion --- source/index.txt | 4 ++-- source/quick-start.txt | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/source/index.txt b/source/index.txt index 91a3a1a2..282139a0 100644 --- a/source/index.txt +++ b/source/index.txt @@ -6,8 +6,8 @@ {+odm+} is the officially supported object-document mapper (ODM) for MongoDB in Ruby. To work with {+odm+} from the command line using -``rails``-like tooling, the `railsmdb -`_ utility can be used. +``rails``-like tooling, you can use the `railsmdb +`_ utility. .. toctree:: :titlesonly: diff --git a/source/quick-start.txt b/source/quick-start.txt index 724a2188..1ab513c0 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -22,7 +22,7 @@ Overview This guide shows you how to use {+odm+} in a new web application, connect to a MongoDB cluster hosted on MongoDB Atlas, and perform -read and write operations on the data. +read and write operations on the data in your cluster. .. tip:: @@ -31,7 +31,8 @@ read and write operations on the data. `. {+odm+} is an Object-Document Mapper (ODM) framework for MongoDB in -Ruby. +Ruby. By using {+odm+}, you can easily interact with your data and +create flexible data models. MongoDB Atlas is a fully managed cloud database service that hosts your MongoDB deployments. You can create your own free (no credit card