Skip to content

Standardization #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 181 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
181 commits
Select commit Hold shift + click to select a range
d05f41a
add actions
mongoKart Dec 4, 2024
f9767f1
Update add-netlify-links.yml (#90) (#91)
github-actions[bot] Dec 5, 2024
e6a256f
DOCSP-45177 - Create a client (#88)
mongoKart Dec 6, 2024
7d361b1
DOCSP-45170: Landing page and cleanup (#89)
norareidy Dec 6, 2024
0905ae3
DOCSP-45171: Download and Install (#92)
norareidy Dec 10, 2024
e681751
DOCSP-45173: Deployment & connection string (#94)
norareidy Dec 10, 2024
aa221f9
DOCSP-45187: Update
mcmorisi Dec 11, 2024
0a1a84c
Fixes
mcmorisi Dec 11, 2024
0610a22
Fix
mcmorisi Dec 11, 2024
1dc855c
DOCSP-45175: Connect to MongoDB (#95)
norareidy Dec 11, 2024
e3e8168
Fix
mcmorisi Dec 11, 2024
1916294
MW feedback
mcmorisi Dec 11, 2024
8899aef
DOCSP-45194: Retrieve data (#96)
norareidy Dec 12, 2024
652c328
DOCSP-45186: Insert
mcmorisi Dec 13, 2024
c3cb6e5
Fix
mcmorisi Dec 13, 2024
4f0be87
Fix
mcmorisi Dec 13, 2024
cbfb1b5
Fix
mcmorisi Dec 13, 2024
bffd7d5
DOCSP-45212 Compatibility (#97)
stephmarie17 Dec 13, 2024
d8cb575
NR feedback
mcmorisi Dec 13, 2024
1cc4598
MW feedback + adjusting code to be more idiomatic
mcmorisi Dec 13, 2024
f2ecc5f
Merge branch 'standardization' into DOCSP-45187-update
mcmorisi Dec 16, 2024
5ab69e7
Merge pull request #98 from mcmorisi/DOCSP-45187-update
mcmorisi Dec 16, 2024
072c5d8
Merge pull request #101 from mcmorisi/DOCSP-45186-insert
mcmorisi Dec 16, 2024
76290fd
DOCSP-45189: Delete
mcmorisi Dec 16, 2024
d4f6968
Fixes
mcmorisi Dec 16, 2024
f2072b3
Fix
mcmorisi Dec 16, 2024
d1bd0f1
DOCSP-45188: Replace
mcmorisi Dec 16, 2024
41dfae2
JS feedback
mcmorisi Dec 16, 2024
18b24a2
DOCSP-45203 Single Field Indexes (#100)
lindseymoore Dec 16, 2024
15a4b12
Technical feedback
mcmorisi Dec 17, 2024
f0bf8cb
Merge branch 'standardization' into DOCSP-45189-delete
mcmorisi Dec 17, 2024
67f93cb
Merge pull request #104 from mcmorisi/DOCSP-45189-delete
mcmorisi Dec 17, 2024
0cc2f1a
DOCSP-45188: Replace
mcmorisi Dec 17, 2024
ed5e532
Fixes
mcmorisi Dec 17, 2024
f5ccbd0
JS feedback
mcmorisi Dec 17, 2024
38eb583
DOCSP-45210 What's New (#99)
stephmarie17 Dec 17, 2024
a1238e5
DOCSP-45195: Project fields (#105)
norareidy Dec 18, 2024
3bc777b
DOCSP-45196: Limit, skip, and sort (#109)
norareidy Dec 19, 2024
91b251a
DOCSP-45193: Specify queries (#102)
norareidy Dec 19, 2024
41cd85e
DOCSP-45197: Count documents (#110)
norareidy Dec 19, 2024
9622639
DOCSP-45198: Distinct values (#111)
norareidy Dec 20, 2024
f45d775
Merge pull request #108 from mcmorisi/DOCSP-45188-replace
mcmorisi Dec 20, 2024
5979ebc
DOCSP-45185: Write landing page
mcmorisi Dec 20, 2024
be2ccbb
Fixes
mcmorisi Dec 20, 2024
43c4f29
MW feedback
mcmorisi Dec 20, 2024
96c104d
DOCSP-45204 Compound Index (#106)
lindseymoore Dec 20, 2024
8a2d3e9
DOCSP-45205 Multikey Indexes (#103)
lindseymoore Dec 20, 2024
14e1d51
Merge pull request #114 from mcmorisi/DOCSP-45185-write
mcmorisi Jan 2, 2025
20dc63d
DOCSP-45190: Bulk Write
mcmorisi Jan 2, 2025
7ebe662
Fixes
mcmorisi Jan 2, 2025
85fda82
link fix
mcmorisi Jan 2, 2025
e4419f9
Fix
mcmorisi Jan 2, 2025
ce616db
JS feedback
mcmorisi Jan 3, 2025
4a2b3e9
DOCSP-45182-ruby-databases-collection-2
gmiller-mdb Jan 3, 2025
7c54189
added api links
gmiller-mdb Jan 3, 2025
f05e713
links
gmiller-mdb Jan 6, 2025
4dc14ff
better link
gmiller-mdb Jan 6, 2025
5c5a1c0
style guide and link fixes
gmiller-mdb Jan 6, 2025
1a7f707
api fixes
gmiller-mdb Jan 6, 2025
371fe51
testing bundler
gmiller-mdb Jan 6, 2025
add6c87
DOCSP-45191: GridFS
mcmorisi Jan 6, 2025
4faf8bb
Fix
mcmorisi Jan 6, 2025
29f2e68
added separate text file, deleted some pages that were added on from …
gmiller-mdb Jan 6, 2025
7699cfb
DOCSP-45214 Add transactions (#115)
stephmarie17 Jan 6, 2025
f5ba735
Merge pull request #116 from mcmorisi/DOCSP-45190-bulk-write
mcmorisi Jan 7, 2025
8e71c76
feedback
gmiller-mdb Jan 7, 2025
70e510e
more feedback
gmiller-mdb Jan 7, 2025
b107d5d
link
gmiller-mdb Jan 7, 2025
ed2bf52
final link
gmiller-mdb Jan 7, 2025
a5ebba3
DOCSP-45191: MW feedback
mcmorisi Jan 7, 2025
93bbe5c
small change
rustagir Jan 7, 2025
1008223
small change
rustagir Jan 7, 2025
c262a4b
revert change
rustagir Jan 7, 2025
7ab49b7
DOCSP-45184-ruby-replica-sets
gmiller-mdb Jan 7, 2025
5824c72
fix errors and links
gmiller-mdb Jan 7, 2025
045cdc7
fixes
gmiller-mdb Jan 7, 2025
3792b7c
link fix
gmiller-mdb Jan 7, 2025
0d2a95e
syntax
gmiller-mdb Jan 7, 2025
2f3d2cb
Merge pull request #118 from mcmorisi/DOCSP-45191-gridfs
mcmorisi Jan 8, 2025
60b0e25
last fixes
gmiller-mdb Jan 8, 2025
d5c1f7d
DOCSP-45183-time-series-collections
gmiller-mdb Jan 8, 2025
3f94a5e
DOCSP-45181: Stable API
mcmorisi Jan 8, 2025
99f5eba
Fix
mcmorisi Jan 8, 2025
ec5bc6f
half feedback
gmiller-mdb Jan 8, 2025
448ee7d
LM feedback
mcmorisi Jan 9, 2025
9f42b50
DOCSP-45199: Cursors (#120)
norareidy Jan 9, 2025
a664c3d
other half of feedback
gmiller-mdb Jan 9, 2025
e5c20d4
style guide
gmiller-mdb Jan 9, 2025
1a33a24
added more copy
gmiller-mdb Jan 9, 2025
3b47405
added page
gmiller-mdb Jan 9, 2025
88abab7
formatting
gmiller-mdb Jan 9, 2025
abb05b6
trying for output
gmiller-mdb Jan 9, 2025
718a9f9
again
gmiller-mdb Jan 9, 2025
dad3ee1
formatting
gmiller-mdb Jan 9, 2025
4628990
Merge pull request #122 from mcmorisi/DOCSP-45181-stable-api
mcmorisi Jan 10, 2025
09a3f3a
DOCSP-45191: GridFS follow-up
mcmorisi Jan 10, 2025
f4b9c93
Fix
mcmorisi Jan 10, 2025
215c065
Jamis technical feedback
mcmorisi Jan 10, 2025
abd60c9
Merge pull request #124 from mcmorisi/DOCSP-45191-gridfs-followup
mcmorisi Jan 10, 2025
6be35cd
add
gmiller-mdb Jan 10, 2025
0943e4b
feedback
gmiller-mdb Jan 10, 2025
54cb8a7
ahh
gmiller-mdb Jan 10, 2025
9bd98fd
toctree
gmiller-mdb Jan 10, 2025
7ba6749
api links
gmiller-mdb Jan 10, 2025
7e3fdf8
feedback
gmiller-mdb Jan 10, 2025
163e14c
Merge remote-tracking branch 'origin/DOCSP-45182-ruby-databases-colle…
gmiller-mdb Jan 13, 2025
3033063
toctree and errors
gmiller-mdb Jan 13, 2025
3f6ce11
file
gmiller-mdb Jan 13, 2025
d674b6a
Merge remote-tracking branch 'origin/DOCSP-45182-ruby-databases-colle…
gmiller-mdb Jan 13, 2025
589ec6c
errors
gmiller-mdb Jan 13, 2025
3d32ea8
DOCSP-45209: Authentication landing + Authentication mechanisms
mcmorisi Jan 14, 2025
ca7ade2
Fixes
mcmorisi Jan 14, 2025
f25cc01
feedback
gmiller-mdb Jan 14, 2025
5d58a29
fix build
gmiller-mdb Jan 14, 2025
a22a699
update toctree
gmiller-mdb Jan 14, 2025
9dfd262
Reorganize auth mechanisms to separate pages
mcmorisi Jan 14, 2025
00100ab
Fix
mcmorisi Jan 14, 2025
3460588
redoing feedback that got merged out
gmiller-mdb Jan 14, 2025
f7d2187
toctree
gmiller-mdb Jan 14, 2025
2d0cec3
Fix
mcmorisi Jan 14, 2025
6318f88
fix typo
gmiller-mdb Jan 14, 2025
a0e0b95
mark troubleshooting todo
gmiller-mdb Jan 14, 2025
1a70647
Merge pull request #117 from gmiller-mdb/DOCSP-45182-ruby-databases-c…
gmiller-mdb Jan 14, 2025
5131020
feedback
gmiller-mdb Jan 14, 2025
ec0e90f
DOCSP-45192-read-data-page
gmiller-mdb Jan 14, 2025
91c62c0
Tweak the Kerberos and IAM pages
mcmorisi Jan 14, 2025
d77b45c
Fix
mcmorisi Jan 14, 2025
76a5b40
wrote page
gmiller-mdb Jan 14, 2025
95656ca
fix links
gmiller-mdb Jan 15, 2025
52e16a6
last link fix
gmiller-mdb Jan 15, 2025
251324b
feedback
gmiller-mdb Jan 15, 2025
25751dc
keyword
gmiller-mdb Jan 15, 2025
227a043
keyword 2
gmiller-mdb Jan 15, 2025
6603cd6
feedback
gmiller-mdb Jan 15, 2025
2e73d11
fix link
gmiller-mdb Jan 15, 2025
5e7944b
MW feedback, round 1
mcmorisi Jan 15, 2025
a064dfa
Fix
mcmorisi Jan 15, 2025
c764505
Fix
mcmorisi Jan 15, 2025
0675173
Kerberos file tweaks, also fixes
mcmorisi Jan 15, 2025
64784d7
Fix
mcmorisi Jan 15, 2025
cb91f17
DOCSP-45176: Run a command
mcmorisi Jan 7, 2025
25bd052
Fix
mcmorisi Jan 15, 2025
2c51aa7
RM feedback
mcmorisi Jan 15, 2025
db7bf96
DOCSP-45202 Index Overview (#112)
lindseymoore Jan 16, 2025
c66b49b
DOCSP-45206 Atlas Search Index (#113)
lindseymoore Jan 16, 2025
5c616c0
DOCSP-45178 Choose a Connection Target (#125)
lindseymoore Jan 16, 2025
c8930a5
feedback
gmiller-mdb Jan 16, 2025
02f359e
feedback
gmiller-mdb Jan 16, 2025
3c79f91
fix toctree issue
gmiller-mdb Jan 16, 2025
6ab7cf9
Merge pull request #119 from gmiller-mdb/DOCSP-45184-ruby-replica-sets
gmiller-mdb Jan 16, 2025
88e62fa
DOCSP-45192-read-data-page
gmiller-mdb Jan 16, 2025
3e8cc97
quotes
gmiller-mdb Jan 16, 2025
c33457b
label
gmiller-mdb Jan 16, 2025
8f8396d
link
gmiller-mdb Jan 16, 2025
ac9d73b
Merge pull request #128 from gmiller-mdb/DOCSP-45192-read-data-page
gmiller-mdb Jan 16, 2025
0b1fa78
Second round of MW feedback
mcmorisi Jan 17, 2025
9f6d8ef
Fixes
mcmorisi Jan 17, 2025
ea80cd3
Fix
mcmorisi Jan 17, 2025
b6a281b
MW feedback
mcmorisi Jan 17, 2025
050267d
feedback
gmiller-mdb Jan 17, 2025
548a9e9
fix typo
gmiller-mdb Jan 17, 2025
2b72e4c
Merge pull request #121 from gmiller-mdb/DOCSP-45183-time-series-coll…
gmiller-mdb Jan 17, 2025
6885e67
DOCSP-45200: Change streams (#123)
norareidy Jan 17, 2025
582daa8
Merge branch 'standardization' into DOCSP-45209-authentication
mcmorisi Jan 17, 2025
12625a2
Merge pull request #127 from mcmorisi/DOCSP-45209-authentication
mcmorisi Jan 17, 2025
7070b94
Jamis feedback
mcmorisi Jan 17, 2025
9e431b4
Merge branch 'standardization' into DOCSP-45176-run-command
mcmorisi Jan 17, 2025
76c5922
Merge pull request #130 from mcmorisi/DOCSP-45176-run-command
mcmorisi Jan 17, 2025
e9ead1c
DOCSP-45179 Configure TLS (#129)
lindseymoore Jan 17, 2025
51d497c
DOCSP-45207 Transform data with aggregation (#131)
stephmarie17 Jan 22, 2025
f3960dd
DOCSP-45812 Connection Options (#132)
lindseymoore Jan 23, 2025
3d3b43b
DOCSP-45211 Upgrade major versions (#134)
stephmarie17 Jan 24, 2025
7436970
DOCSP-46860: In-use encryption (#138)
norareidy Jan 28, 2025
8d8a159
DOCSP-45201 Cluster monitoring (#133)
lindseymoore Jan 29, 2025
c3375b0
DOCSP-45180 Server selection (#135)
lindseymoore Jan 29, 2025
b7e219d
DOCSP-46862 Issues & Help (#139)
lindseymoore Jan 29, 2025
9419901
DOCSP-42104 CSOT (#136)
lindseymoore Jan 30, 2025
9dd693b
DOCSP-46650: Cleanup (#137)
norareidy Jan 31, 2025
982a505
Merge remote-tracking branch 'upstream/master' into standardization
norareidy Jan 31, 2025
7c87171
remove old redirects
norareidy Jan 31, 2025
e4ed3f9
LM feedback
norareidy Jan 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ source/images/*
*.bak
source/images
source/figures
source/
source-master/
source-v*/
source-v2.0/
Expand All @@ -16,5 +15,7 @@ meta.yaml
source/includes/hash.rst
source/includes/table/
source/includes/toc
bson-ruby/
mongo-ruby-driver/
fabfile
giza.log
437 changes: 0 additions & 437 deletions .yardoc/checksums

This file was deleted.

Empty file removed .yardoc/complete
Empty file.
Binary file removed .yardoc/object_types
Binary file not shown.
Binary file removed .yardoc/objects/root.dat
Binary file not shown.
Binary file removed .yardoc/proxy_types
Binary file not shown.
121 changes: 0 additions & 121 deletions Makefile

This file was deleted.

42 changes: 42 additions & 0 deletions REVIEWING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Pull Request Reviewing Guidelines for Ruby Driver Documentation

Contributions to the set of documents in this repository can receive reviews from one or both of the following types of reviews:

1. A **copy review**, which focuses on information structure and wording; typically performed by a MongoDB Documentation Team member
2. A **technical review**, which addresses code snippets and the technical correctness of prose; typically performed by a MongoDB engineer.

See the following sections for reviewer expectations for each type of pull request (PR) review:

## Copy Review

Review the structure, wording, and flow of the information in the PR, and correct it if necessary.

### What to Review

- Wording
- Page structure
- Technical content to the extent of the reviewer’s understanding.
- Whether the PR fulfills the Acceptance Criteria described in the
linked JIRA ticket.

### What Not to Review

Nothing is completely off-limits to a copy review of a PR -- if you notice a technical issue, it's best to call it out early.
Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket, or otherwise create PRs to address anything unrelated.

## Technical Review

Review the technical accuracy and completeness of a PR and correct it if necessary.

### What to Review

- Code snippets; ensure the code is idiomatic and that all technical claims are correct. e.g. ("To create a `Foo`, use the `Bar.createFoo()` method")
- Problematic explanations that could trip up users who try to follow the documentation.

### What Not to Review

While we welcome any recommendations on wording and structure, avoid blocking approval based on any copy edits. Please entrust the author to make the writing decisions based on style guidelines and team-specific writing conventions, and to create PRs to address anything they deem outside the technical review scope.

- Wording of sentences, although corrections to technical claims are welcome
- Structure of the page
- Any unchanged lines outside the PR unless relevant to the ticket acceptance criteria.
26 changes: 0 additions & 26 deletions conf-sitemap.xml

This file was deleted.

43 changes: 0 additions & 43 deletions config/build_conf.yaml

This file was deleted.

Loading
Loading