Skip to content

Commit 1010e7f

Browse files
norareidynorareidy
committed
put old files in folder
1 parent 0755baa commit 1010e7f

38 files changed

+10973
-0
lines changed

‎source/old-content/contribute.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
************************
2+
Contribute to the Driver
3+
************************
4+
5+
.. default-domain:: mongodb
6+
7+
Report Bugs and Request Ruby Driver-Specific Features
8+
=====================================================
9+
10+
To report a bug in the driver or request a feature specific to the Ruby driver:
11+
12+
1. Visit `our issue tracker <https://jira.mongodb.org/>`_ and login
13+
(or create an account if you do not have one already).
14+
2. Navigate to the `RUBY project <https://jira.mongodb.org/browse/RUBY>`_.
15+
3. Click :guilabel:`Create Issue` and fill out all of the applicable form
16+
fields.
17+
18+
When creating an issue, please keep in mind that all information in JIRA
19+
for the RUBY project, as well as the core server (the SERVER project),
20+
is publicly visible.
21+
22+
**PLEASE DO:**
23+
24+
- Provide as much information as possible about the issue.
25+
- Provide detailed steps for reproducing the issue.
26+
- Provide any applicable code snippets, stack traces and log data.
27+
Do not include any sensitive data or server logs.
28+
- Specify version numbers of the driver and MongoDB server.
29+
30+
**PLEASE DO NOT:**
31+
32+
- Provide any sensitive data or server logs.
33+
- Report potential security issues publicly (see 'Security Issues' below).
34+
35+
.. note::
36+
37+
Bug reports in JIRA for the Ruby driver and the core server (the **SERVER**)
38+
projects are public.
39+
40+
If you identified a potential security vulnerability in the Ruby driver or
41+
any other MongoDB product, please report it according to the instructions found
42+
in the :manual:`Create a Vulnerability Report
43+
</tutorial/create-a-vulnerability-report>`.
44+
45+
46+
Request Product Features
47+
========================
48+
49+
To request a feature which is not specific to the Ruby driver, or which
50+
affects more than the driver alone (for example, a feature which requires
51+
MongoDB server support), please submit your idea through the
52+
`MongoDB Feedback Forum <https://feedback.mongodb.com/forums/924286-drivers>`_.
53+
54+
55+
Contribute Code
56+
===============
57+
58+
The MongoDB Ruby driver source is located
59+
`at GitHub <https://github.com/mongodb/mongo-ruby-driver>`_.
60+
61+
The list of known issues in the driver is available
62+
`in JIRA <https://jira.mongodb.org/browse/RUBY>`_.
63+
64+
We recommend creating a JIRA ticket before starting work on a bug fix or
65+
an improvement to the driver, to obtain feedback from the Ruby driver team
66+
as to the proposed changes. A JIRA ticket is not required to submit
67+
a pull request but it is appreciated, especially for non-trivial changes.
68+
69+
Pull requests should be made against the ``master`` branch and
70+
include relevant tests, if applicable. The Ruby driver team will backport
71+
the changes to the stable branches, if needed.
72+
73+
A MongoDB deployment is required to run the tests. Setup procedures and
74+
recommendations for various deployments, as well as how to configure the
75+
driver's test suite for the deployments, are covered in the `spec
76+
readme <https://github.com/mongodb/mongo-ruby-driver/blob/master/spec/README.md>`__.
77+
78+
The driver is tested on `Evergreen <https://github.com/evergreen-ci/evergreen>`_,
79+
MongoDB's in-house continuous integration platform. After a pull request
80+
is created, one of the Ruby driver team engineers will schedule an Evergreen
81+
build.

‎source/old-content/getting-started.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _getting-started:
2+
3+
***************
4+
Getting Started
5+
***************
6+
7+
.. default-domain:: mongodb
8+
9+
.. toctree::
10+
:titlesonly:
11+
12+
Installation <installation>
13+
Driver Compatibility <reference/driver-compatibility>
14+
Support <support>
15+
16+
This section describes how to install the driver, installation prerequisites,
17+
and compatibility considerations.

‎source/old-content/installation.txt

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
************
2+
Installation
3+
************
4+
5+
.. default-domain:: mongodb
6+
7+
The Ruby driver is released as a gem hosted on `Rubygems
8+
<https://rubygems.org/gems/mongo>`_.
9+
10+
11+
Prerequisites
12+
=============
13+
14+
Please see the :ref:`compatibility <compatibility>` page for the list of
15+
Ruby versions and MongoDB server versions that this release of the Ruby
16+
driver is compatible with.
17+
18+
The driver itself is written entirely in Ruby, however it depends on the
19+
`bson library <https://rubygems.org/gems/bson>`_ which includes a C extension
20+
for MRI and a compiled Java extension for JRuby. A working C compiler and Ruby
21+
development headers and libraries are required when installing on MRI.
22+
When installing on JRuby, JRE is sufficient because the ``bson`` gem includes
23+
the compiled extension.
24+
25+
Connecting to TLS-enabled MongoDB servers, using SCRAM authentication
26+
(both SCRAM-SHA-1 and SCRAM-SHA-256) and using X.509 authentication (which
27+
is performed over a TLS connection) requires the Ruby ``openssl`` extension
28+
to be present and working. The :ref:`TLS compatibility <tls-compatibility>`
29+
section provides further details on usage of newer TLS protocols like TLS 1.1.
30+
31+
32+
.. _installation:
33+
34+
Install the Gem
35+
===============
36+
37+
Add ``mongo`` to your ``Gemfile``:
38+
39+
.. code-block:: ruby
40+
41+
gem "mongo", "~> 2"
42+
43+
To install the driver manually:
44+
45+
.. code-block:: sh
46+
47+
gem install mongo -v '~> 2'
48+
49+
50+
What's New
51+
==========
52+
53+
Please see the :ref:`release notes <release-notes>` for the major changes
54+
in each driver release and the `releases page on GitHub
55+
<https://github.com/mongodb/mongo-ruby-driver/releases>`_ for the complete
56+
list of changes for each release of the driver.

‎source/old-content/reference/additional-resources.txt

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
.. _ruby-external-resources:
2+
3+
********************
4+
Additional Resources
5+
********************
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: twocols
14+
15+
There are a number of good resources appearing all over the web for
16+
learning about MongoDB and Ruby. A useful selection is listed below. If
17+
you know of others, do let us know.
18+
19+
Screencasts
20+
===========
21+
22+
- `Introduction to MongoDB - Part I
23+
<http://teachmetocode.com/screencasts/introduction-to-mongodb-part-i>`_
24+
25+
An introduction to MongoDB via the MongoDB shell.
26+
27+
- `Introduction to MongoDB - Part II
28+
<http://teachmetocode.com/screencasts/introduction-to-mongodb-part-ii>`_
29+
30+
In this screencast, Joon You teaches how to use the Ruby driver to
31+
build a simple Sinatra app.
32+
33+
- `Introduction to MongoDB - Part III
34+
<http://teachmetocode.com/screencasts/introduction-to-mongodb-part-iii-mongomapper-rails>`_
35+
36+
For the final screencast in the series, Joon You introduces
37+
MongoMapper and Rails.
38+
39+
- `RailsCasts: MongoDB & MongoMapper
40+
<http://railscasts.com/episodes/194-mongodb-and-mongomapper>`_
41+
42+
Ryan Bates' RailsCast introducing MongoDB and MongoMapper.
43+
44+
- `RailsCasts: Mongoid <http://railscasts.com/episodes/238-mongoid>`_
45+
46+
Ryan Bates' RailsCast introducing Mongoid.
47+
48+
Presentations
49+
=============
50+
51+
- `Introduction to MongoDB (Video) <http://pivotallabs.com/talks/85>`_
52+
53+
Mike Dirolf's introduction to MongoDB at Pivotal Labs, SF.
54+
55+
- `MongoDB: A Ruby Document Store that doesn't rhyme with 'Ouch'
56+
(Slides)
57+
<http://www.slideshare.net/pengwynn/mongodb-ruby-document-store-that-doesnt-rhyme-with-ouch>`_
58+
59+
Wynn Netherland's introduction to MongoDB with some comparisons to
60+
CouchDB.
61+
62+
- `MongoDB (is) for Rubyists (Slides)
63+
<http://www.slideshare.net/kbanker/mongodb-is-for-rubyists-boston-ruby>`_
64+
65+
Kyle Banker's presentation on why MongoDB is for Rubyists (and all
66+
human-oriented programmers).
67+
68+
Articles
69+
========
70+
71+
- `Why I Think Mongo is to Databases What Rails was to Frameworks
72+
<http://railstips.org/blog/archives/2009/12/18/why-i-think-mongo-is-to-databases-what-rails-was-to-frameworks/>`_
73+
74+
- `What if a key-value store mated with a relational database system?
75+
<http://railstips.org/2009/6/3/what-if-a-key-value-store-mated-with-a-relational-database-system>`_
76+
77+
- `Mongo Tips <http://mongotips.com>`_
78+
79+
John Nunemaker's articles on MongoDB and his Mongo Tips blog.
80+
81+
- A series of articles on aggregation with MongoDB and Ruby:
82+
83+
1. `Part I: Introduction of Aggregation in MongoDB
84+
<http://kylebanker.com/blog/2009/11/mongodb-count-group/>`_
85+
86+
#. `Part II: MongoDB Grouping Elaborated
87+
<http://kylebanker.com/blog/2009/11/mongodb-advanced-grouping/>`_
88+
89+
#. `Part III: Introduction to Map-Reduce in MongoDB
90+
<http://kylebanker.com/blog/2009/11/mongodb-advanced-grouping/>`_
91+
92+
- `Does the MongoDB Driver Support Feature X?
93+
<http://kylebanker.com/blog/2010/03/28/does-the-driver-support-feature-x/>`_
94+
95+
An explanation of how the MongoDB drivers usually automatically
96+
support new database features.
97+
98+
Projects
99+
========
100+
101+
- `Capistrano Mongo Sync <https://www.openlistings.com/capistrano-mongo-sync-ruby-gem>`_
102+
103+
Sync your local development db with your remote production db using capistrano.
104+
105+
- `Simple Pub/Sub <https://gist.github.com/669309>`_
106+
107+
A very simple pub/sub system.
108+
109+
- `Mongo Queue <http://github.com/Skiz/mongo_queue>`_
110+
111+
An extensible thread safe job/message queueing system that uses
112+
MongoDB as the persistent storage engine.
113+
114+
- `Resque-mongo <http://github.com/ctrochalakis/resque-mongo>`_
115+
116+
A port of the Github's Resque to MongoDB.
117+
118+
- `Mongo Admin <http://github.com/ahe/mongo_admin>`_
119+
120+
A Rails plugin for browsing and managing MongoDB data. See the `live
121+
demo <http://mongo_admin.2dconcept.com>`_.
122+
123+
- `Sinatra Resource <http://github.com/djsun/sinatra_resource>`_
124+
125+
Resource Oriented Architecture (REST) for Sinatra and MongoMapper.
126+
127+
- `NewsMonger <http://github.com/banker/newsmonger>`_
128+
129+
A simple social news application demonstrating MongoMapper and Rails.
130+
131+
- `Data Catalog API <http://github.com/sunlightlabs/datacatalog-api>`_
132+
133+
From `Sunlight Labs <http://www.sunlightlabs.com/>`_, a non-trivial
134+
application using MongoMapper and Sinatra.
135+
136+
- `Watchtower <http://github.com/kneath/watchtower/>`_
137+
138+
An example application using Mustache, MongoDB, and Sinatra.
139+
140+
- `Shapado <http://github.com/patcito/Shapado>`_
141+
142+
A question and answer site similar to Stack Overflow. Live version at
143+
`shapado.com <http://shapado.com>`_.
144+
145+
.. Does not seem to exist
146+
.. - `Shorty <http://github.com/dancroak/shorty/>`_
147+
.. A URL-shortener written with Sinatra and the MongoDB Ruby driver.
148+
149+
Libraries
150+
=========
151+
152+
- `ActiveExpando <http://github.com/hayesdavis/active-expando>`_
153+
154+
An extension to ActiveRecord to allow the storage of arbitrary
155+
attributes in MongoDB.
156+
157+
- `ActsAsTree (MongoMapper)
158+
<http://github.com/ramdiv/mongo_mapper_acts_as_tree>`_
159+
160+
ActsAsTree implementation for MongoMapper.
161+
162+
- `Machinist adapter (MongoMapper)
163+
<http://github.com/yeastymobs/machinist_mongomapper/tree/master>`_
164+
165+
Machinist adapter using MongoMapper.
166+
167+
- `Mongo-Delegate <http://github.com/mharris717/mongo_delegate>`_
168+
169+
A delegation library for experimenting with production data without
170+
altering it. A quite useful pattern.
171+
172+
- `Remarkable Matchers (MongoMapper)
173+
<http://github.com/nmerouze/machinist_mongo>`_
174+
175+
Testing / Matchers library using MongoMapper.
176+
177+
- `OpenIdAuthentication, supporting MongoDB as the datastore
178+
<http://github.com/collectiveidea/open_id_authentication>`_
179+
180+
Brandon Keepers' fork of OpenIdAuthentication supporting MongoDB.
181+
182+
- `MongoTree (MongoRecord)
183+
<http://github.com/mully/mongo_tree/tree/master>`_
184+
185+
MongoTree adds parent / child relationships to MongoRecord.
186+
187+
- `Merb_MongoMapper
188+
<http://github.com/shingara/merb_mongomapper/tree/master>`_
189+
190+
A plugin for the Merb framework for supporting MongoMapper models.
191+
192+
- `Mongolytics (MongoMapper)
193+
<http://github.com/tpitale/mongolytics/tree/master>`_
194+
195+
A web analytics tool.
196+
197+
- `Rack-GridFS <http://github.com/skinandbones/rack-gridfs/>`_
198+
199+
A Rack middleware component that creates HTTP endpoints for files
200+
stored in GridFS.

0 commit comments

Comments
 (0)