|
1 |
| -## Pull Request Info |
| 1 | +## Pull Request Info - SDK Docs Consolidation |
2 | 2 |
|
3 | 3 | Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
|
4 | 4 |
|
5 |
| -- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): description of changes |
| 5 | +*Staged Page* |
6 | 6 |
|
7 |
| -### Reminder Checklist |
| 7 | +- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/) |
8 | 8 |
|
9 |
| -Before merging your PR, make sure to check a few things. |
| 9 | +*Page Source* |
10 | 10 |
|
11 |
| -- [ ] Did you tag pages appropriately? |
| 11 | +Add links to every SDK's pages where you got the SDK-specific information: |
| 12 | + |
| 13 | +- [PAGE_NAME](https://www.mongodb.com/docs/atlas/device-sdks/LIVE-DOCS-LINK) |
| 14 | + |
| 15 | +### PR Author Checklist |
| 16 | + |
| 17 | +Before requesting a review for your PR, please check these items: |
| 18 | + |
| 19 | +- [ ] Open the PR against the `feature-consolidated-sdk-docs` branch instead of `master` |
| 20 | +- [ ] Tag the consolidated page for: |
12 | 21 | - genre
|
13 | 22 | - meta.keywords
|
14 | 23 | - meta.description
|
15 |
| -- [ ] Describe your PR's changes in the Release Notes section |
16 |
| -- [ ] Create a Jira ticket for related docs-app-services work, if any |
17 | 24 |
|
18 |
| -### Release Notes |
| 25 | +#### Naming |
| 26 | +- [ ] Update Realm naming and the language around persistence layer/local/device per [this document](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing) |
| 27 | +- [ ] Include `.rst` files comply with [the naming guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9) |
| 28 | + |
| 29 | +#### Links and Refs |
| 30 | +- [ ] Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections |
| 31 | +- [ ] Remove or update any SDK-specific refs to use the new consolidated SDK ref targets |
| 32 | +- [ ] [Update any Kotlin API links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new Kotlin SDK roles |
| 33 | + |
| 34 | +#### Content |
| 35 | +- [ ] Shared code boxes have snippets or placeholders for all 9 languages |
| 36 | +- [ ] API description sections have API details or a generic placeholder for all 9 languages |
| 37 | +- [ ] Check related pages for relevant content to include |
| 38 | +- [ ] Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic |
19 | 39 |
|
20 |
| -<!-- |
21 |
| -- **Kotlin** SDK |
22 |
| - - Realm/Manage Realm Files/Encrypt a Realm: Add information on encryption for |
23 |
| - local and synced realms. |
24 |
| ---> |
| 40 | +### Reviewer Checklist |
25 | 41 |
|
26 |
| -### Review Guidelines |
| 42 | +As a reviewer, please check these items: |
27 | 43 |
|
28 |
| -[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) |
| 44 | +- [ ] Shared code example boxes contain language-specific snippets or placeholders for every language |
| 45 | +- [ ] API reference details contain working API reference links or generic content |
| 46 | +- [ ] Realm naming/language has been updated |
| 47 | +- [ ] All relevant content from individual SDK pages is present on the consolidated page |
0 commit comments