Skip to content

Commit 5ea21b6

Browse files
authored
PHPLIB-605: Update instructions for external doc updates (#800)
1 parent aa26460 commit 5ea21b6

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -203,9 +203,22 @@ Release announcements should also be sent to the [MongoDB Product & Driver Annou
203203
Consider announcing each release on Twitter. Significant releases should also be
204204
announced via [@MongoDB](http://twitter.com/mongodb) as well.
205205

206-
### Update compatibility tables in MongoDB docs
206+
### Documentation Updates for New Major and Minor Versions
207+
208+
New major and minor releases will also require documentation updates to other
209+
projects:
210+
211+
* Create a DOCSP ticket to add the new version to PHP's server and language
212+
[compatibility tables](https://docs.mongodb.com/drivers/php/#compatibility)
213+
in the driver docs portal. See
214+
[mongodb/docs-ecosystem#642](https://github.com/mongodb/docs-ecosystem/pull/642)
215+
for an example.
216+
217+
* Create a DOCSP ticket to update the "current" and "upcoming" navigation links
218+
in the library's [documentation](https://docs.mongodb.com/php-library/). This
219+
will require updating
220+
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library).
221+
222+
These tasks can be initiated prior to tagging a new release to ensure that the
223+
updated content becomes accessible soon after the release is published.
207224

208-
For minor releases, create a DOCSP ticket indicating whether there are changes to MongoDB Server or PHP version
209-
compatibility. The [compatibility tables](https://docs.mongodb.com/drivers/driver-compatibility-reference#php-driver-compatibility)
210-
in the MongoDB documentation must be updated to account for new releases. Make sure to update both MongoDB and Language
211-
compatibility tables, as shown in [this pull request](https://github.com/mongodb/docs-ecosystem/pull/642).

0 commit comments

Comments
 (0)