Skip to content

Commit

Permalink
DOCSP-35392: update laravel docs link
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Cho committed Jan 22, 2024
1 parent ca9b21d commit 83b457e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 21 deletions.
38 changes: 22 additions & 16 deletions REVIEWING.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,48 @@
# Pull Request Reviewing Guidelines for Driver Ecosystem Documentation
# Pull Request Reviewing Guidelines for the Driver Ecosystem 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.
2. A **technical review**, which addresses code snippets and the technical correctness of prose, typically performed by a MongoDB engineer.

# Which Types of Changes for which to Request a Technical Review

- When the PR changes include code snippets.
- When the PR changes include release notes, breaking changes, or upgrading versions.
- To get alignment on specific wording of descriptions of technical information, especially for new features.
- If in doubt, request a technical review.

# What to Review

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.
A typical copy review consists of the following checks:

### What to Review

- Wording
- Wording, including grammar and spelling
- Page structure
- Technical content to the extent of the reviewers understanding.
- Technical content to the extent of the reviewer's understanding
- Whether the PR fulfills the Acceptance Criteria described in the
linked JIRA ticket.
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.

Nothing is entirely 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
A typical technical review consists of the following checks:

- 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")
- Technical accuracy
- Release notes, breaking changes, and upgrading pages; ensure the technical claims are correct.
- 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.
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
Expand Down
11 changes: 6 additions & 5 deletions source/php-libraries.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,11 @@ Framework Integrations

- Laravel

- `Laravel MongoDB <https://github.com/mongodb/laravel-mongodb>`__ is an
Eloquent model and Query builder that supports MongoDB by using the
original Laravel API. This library extends the original Laravel classes
and therefore uses the same methods.
- `Laravel MongoDB <https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/>`__
is MongoDB's official Eloquent model and query builder that supports
MongoDB by using the original Laravel API. This package extends the PHP
Laravel classes to work with MongoDB as a datastore in your Laravel
application.

- Symfony

Expand Down Expand Up @@ -100,4 +101,4 @@ Tools and Projects
a common way for programs to create, send, and read messages.

- `XHGui <https://github.com/perftools/xhgui>`__ is a web interface for the
XHProf profiler, which stores profiling data in MongoDB.
XHProf profiler, which stores profiling data in MongoDB.

0 comments on commit 83b457e

Please sign in to comment.