Skip to content

Commit 7f49bed

Browse files
dacharyccbullinger
andauthored
Update PR template for the docs consolidation project (#3256)
## Pull Request Info This PR updates the PR template to add consolidation-specific checklists for the PR author and reviewer. I've renamed the existing template to `pull_request_template-base.md` to preserve it in the repo, so we can easily switch back to it after the consolidation project is complete. --------- Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
1 parent 0b2c3cc commit 7f49bed

File tree

2 files changed

+60
-15
lines changed

2 files changed

+60
-15
lines changed

.github/pull_request_template-base.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Pull Request Info
2+
3+
Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
4+
5+
### Staged Pages
6+
7+
- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): description of changes
8+
9+
### Reminder Checklist
10+
11+
Before merging your PR, did you:
12+
13+
- [ ] Describe your PR's changes in the Release Notes section
14+
- [ ] Create a Jira ticket for related docs-app-services work, if any
15+
16+
### Release Notes
17+
18+
<!--
19+
- **Kotlin** SDK
20+
- Realm/Manage Realm Files/Encrypt a Realm: Add information on encryption for
21+
local and synced realms.
22+
-->
23+
24+
### Review Guidelines
25+
26+
[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

.github/pull_request_template.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,47 @@
1-
## Pull Request Info
1+
## Pull Request Info - SDK Docs Consolidation
22

33
Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
44

5-
- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): description of changes
5+
*Staged Page*
66

7-
### Reminder Checklist
7+
- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/)
88

9-
Before merging your PR, make sure to check a few things.
9+
*Page Source*
1010

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:
1221
- genre
1322
- meta.keywords
1423
- 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
1724

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
1939

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
2541

26-
### Review Guidelines
42+
As a reviewer, please check these items:
2743

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

Comments
 (0)