Skip to content

DOCSP-45177 - Create a client #88

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 10 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 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 Down
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