Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fast follows #3380

Merged
merged 2 commits into from
Sep 9, 2024
Merged

Fast follows #3380

merged 2 commits into from
Sep 9, 2024

Conversation

krollins-mdb
Copy link
Collaborator

@krollins-mdb krollins-mdb commented Sep 9, 2024

## Pull Request Info - SDK Docs Consolidation

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

### Staging Links
<!-- start insert-links -->
<li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/cpp/facets.toml>sdk/cpp/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/dotnet/facets.toml>sdk/dotnet/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/flutter/facets.toml>sdk/flutter/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/kotlin/facets.toml>sdk/kotlin/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/node/facets.toml>sdk/node/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/react-native/facets.toml>sdk/react-native/facets.toml</a></li><li><a
href=https://deploy-preview-3378--docs-realm.netlify.app/sdk/swift/facets.toml>sdk/swift/facets.toml</a></li>
<!-- end insert-links -->

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

-
[PAGE_NAME](https://www.mongodb.com/docs/atlas/device-sdks/LIVE-DOCS-LINK)

### PR Author Checklist

Before requesting a review for your PR, please check these items:

- [ ] Open the PR against the `feature-consolidated-sdk-docs` branch
instead of `master`
- [ ] Tag the consolidated page for:
  - genre
  - meta.keywords
  - meta.description

#### Naming
- [ ] 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)
- [ ] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### Links and Refs
- [ ] Create new consolidated SDK ref targets starting with "_sdks-" for
relevant sections
- [ ] Remove or update any SDK-specific refs to use the new consolidated
SDK ref targets
- [ ] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [ ] Shared code boxes have snippets or placeholders for all 9
languages
- [ ] API description sections have API details or a generic placeholder
for all 9 languages
- [ ] Check related pages for relevant content to include
- [ ] Create a ticket for missing examples in each relevant SDK:
Consolidation Gaps epic

### Reviewer Checklist

As a reviewer, please check these items:

- [ ] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [ ] API reference details contain working API reference links or
generic content
- [ ] Realm naming/language has been updated
- [ ] All relevant content from individual SDK pages is present on the
consolidated page
Copy link

netlify bot commented Sep 9, 2024

Deploy Preview for device-sdk ready!

Name Link
🔨 Latest commit 9f01ae4
🔍 Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/66df2515d31559000885f30a
😎 Deploy Preview https://deploy-preview-3380--device-sdk.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Sep 9, 2024

Readability for Commit Hash: 9f01ae4

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score Difficulty
90-100 Very Easy
80-89 Easy
70-79 Fairly Easy
60-69 Medium
50-59 Fairly Hard
30-49 Hard
0-29 Very Hard

For help improving readability, try Hemingway App.

@krollins-mdb krollins-mdb marked this pull request as ready for review September 9, 2024 16:45
@krollins-mdb krollins-mdb merged commit 7642864 into mongodb:master Sep 9, 2024
10 of 11 checks passed
@krollins-mdb krollins-mdb deleted the fast-follows branch September 9, 2024 16:57
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants