|
1 | | -## Pull Request Info - SDK Docs Consolidation |
| 1 | +## Pull Request Info |
2 | 2 |
|
3 | 3 | Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN |
4 | | - |
5 | | -### Staging Links |
6 | | -<!-- start insert-links --> |
7 | | -- |
8 | | -<!-- end insert-links --> |
9 | | - |
10 | | -*Page Source* |
11 | | - |
12 | | -Add links to every SDK's pages where you got the SDK-specific information: |
13 | | - |
14 | | -- [PAGE_NAME](https://www.mongodb.com/docs/atlas/device-sdks/LIVE-DOCS-LINK) |
15 | | - |
16 | | -### Release Notes |
17 | | - |
18 | | -<!-- |
19 | | -- **Define Data Access Permissions** |
20 | | - - Data Access Role Examples: Update CRUD Permissions example screenshots and |
21 | | - copyable JSON |
22 | | ---> |
23 | | - |
24 | | -### PR Author Checklist |
25 | | - |
26 | | -Before requesting a review for your PR, please check these items: |
27 | | - |
28 | | -- [ ] Open the PR against the `feature-consolidated-sdk-docs` branch instead of `master` |
29 | | -- [ ] Tag the consolidated page for: |
30 | | - - genre |
31 | | - - meta.keywords |
32 | | - - meta.description |
33 | | - |
34 | | -#### Naming |
35 | | -- [ ] 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) |
36 | | -- [ ] Include `.rst` files comply with [the naming guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9) |
37 | | - |
38 | | -#### Links and Refs |
39 | | -- [ ] Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections |
40 | | -- [ ] Remove or update any SDK-specific refs to use the new consolidated SDK ref targets |
41 | | -- [ ] [Update any Kotlin API links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new Kotlin SDK roles |
42 | | - |
43 | | -#### Content |
44 | | -- [ ] Shared code boxes have snippets or placeholders for all 9 languages |
45 | | -- [ ] API description sections have API details or a generic placeholder for all 9 languages |
46 | | -- [ ] Check related pages for relevant content to include |
47 | | -- [ ] Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic |
48 | | - |
49 | | -### Reviewer Checklist |
50 | | - |
51 | | -As a reviewer, please check these items: |
52 | | - |
53 | | -- [ ] Shared code example boxes contain language-specific snippets or placeholders for every language |
54 | | -- [ ] API reference details contain working API reference links or generic content |
55 | | -- [ ] Realm naming/language has been updated |
56 | | -- [ ] All relevant content from individual SDK pages is present on the consolidated page |
0 commit comments