-
Notifications
You must be signed in to change notification settings - Fork 29
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
mongoKart
merged 10 commits into
mongodb:standardization
from
mongoKart:docsp-45177-mongoclient
Dec 6, 2024
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
df2057f
first draft
mongoKart ef8c194
add client file
mongoKart d25c330
update keywords
mongoKart 61d5fa4
autobuilder
mongoKart 82a0daa
fixes
mongoKart 32c991a
remove extraneous files
mongoKart f3227ef
add connect to index
mongoKart 50671d7
feedback
mongoKart 0dd102d
fix broken table
mongoKart 715cf3c
feedback fix
mongoKart File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,6 @@ source/images/* | |
*.bak | ||
source/images | ||
source/figures | ||
source/ | ||
source-master/ | ||
source-v*/ | ||
source-v2.0/ | ||
|
This file was deleted.
Oops, something went wrong.
Empty file.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Pull Request Reviewing Guidelines for C#/.NET 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. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copy/paste artifact? I assume this is supposed to be "Ruby Driver Documentation".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure is. good catch