(DOCSP-39516): Consolidate Delete page #3336

dacharyc · 2024-07-23T21:49:09Z

Pull Request Info - SDK Docs Consolidation

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

Staged Page

Delete

Note for reviewer: there are some API description tab sets where one or more tabs is missing a description. That's intentional. In some cases, there is no relevant info to provide because we're missing an example, and in other cases, it's because I needed to provide additional info for one of the languages but didn't have anything relevant to say for the other languages.

Page Source

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

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
Include .rst files comply with the naming guidelines

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 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

netlify · 2024-07-23T21:49:28Z

✅ Deploy Preview for device-sdk ready!

Name	Link
🔨 Latest commit	`dc3bdf9`
🔍 Latest deploy log	https://app.netlify.com/sites/device-sdk/deploys/66b223dcefeed30008772f62
😎 Deploy Preview	https://deploy-preview-3336--device-sdk.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 31 (🟢 up 6 from production) Accessibility: 92 (🔴 down 1 from production) Best Practices: 75 (no change from production) SEO: 62 (🔴 down 7 from production) PWA: - View the detailed breakdown and full score reports

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

github-actions · 2024-07-23T21:50:31Z

Readability for Commit Hash: dc3bdf9

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

Readability scores for changed documents:

source/sdk/crud/delete: Grade Level: 8.4, Reading Ease: 58.18
source/sdk/crud/update: Grade Level: 10.4, Reading Ease: 31.55

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

@dacharyc, yet again amazing work! You've done an excellent job bringing all of this content together.

Requesting changes for a good number of API ref links that should be updated and one minor instance of "realm" that could go away.

krollins-mdb · 2024-08-05T15:24:09Z

source/includes/api-details/csharp/crud/delete-multiple-objects-description.rst

+for the objects you want to delete to :dotnet-sdk:`Realm.RemoveRange<T> 
+<reference/Realms.Realm.html#Realms_Realm_RemoveRange__1_System_Linq_IQueryable___0__>`.


This link is broken when rendered. It resolves to /latest/T%3E%3Creference/.../ when it should be /latest/reference/.../. The <T> seems to be breaking it, as it is interpreted and not rendered. Do we have a way to escape characters in Snooty roles?

Alternatively, we could remove the argument types from our links, like we do in Dart. I think it's nice to have them though.

krollins-mdb · 2024-08-05T15:26:51Z

source/includes/api-details/csharp/crud/delete-all-objects-of-type-description.rst

+To delete all objects of a type, call :dotnet-sdk:`Realm.RemoveAll<T> 
+<reference/Realms.Realm.html#Realms_Realm_RemoveAll__1>`.


Same character escape issue as I mentioned in the delete-multiple-objects-description file.

krollins-mdb · 2024-08-05T15:28:45Z

...ce/includes/api-details/csharp/crud/delete-an-object-and-its-related-objects-description.rst

+In the following example, we call :dotnet-sdk:`Realm.RemoveRange<T> 
+<reference/Realms.Realm.html#Realms_Realm_RemoveRange__1_System_Linq_IQueryable___0__>`


Broken link due to character escaping issue.

source/includes/api-details/java/crud/delete-single-object-description.rst

source/includes/api-details/java/crud/delete-multiple-objects-description.rst

source/includes/api-details/java/crud/delete-all-objects-in-the-database-description.rst

source/includes/api-details/kotlin/crud/delete-remove-elements-from-list-description.rst

source/includes/api-details/kotlin/crud/delete-remove-elements-from-set-description.rst

source/sdk/crud/delete.txt

Co-authored-by: Kyle Rollins <115574589+krollins-mdb@users.noreply.github.com>

krollins-mdb

LGTM! Thank you, @dacharyc!

docs-builder-bot · 2024-08-06T15:38:57Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/

🪵 Logs

job log: 8f7001a2de41d218be831b5ba998a2caa4a0be23

Scaffold page with Kotlin examples and descriptions

296df39

dacharyc added the merge to feature branch Unreleased feature - do not merge to Master label Jul 23, 2024

dacharyc added 17 commits July 23, 2024 17:53

Fix snooty build errors

a879921

Add C++ examples

ca25bc8

Add C# examples

a893714

Add Dart examples

9668858

Add Java examples

432e4ee

Add JavaScript examples

cbd56c0

Add Swift and Objective-C examples

0b33e68

Fix build error

1b5327b

Start adding missing Swift and Objective-C API descriptions

eaf86fe

Add missing colon

0669d1d

Add remaining Swift and Objc descriptions

263eda6

Add missing Java API descriptions

2f6daa5

Add missing C# descriptions

818ce90

Add missing Dart API descriptions

d7a5efb

Add missing JavaScript API descriptions

2d9d392

Add missing C++ descriptions

421cb78

Final fixups before review

d508012

dacharyc marked this pull request as ready for review July 30, 2024 16:40

krollins-mdb requested changes Aug 5, 2024

View reviewed changes

dacharyc and others added 2 commits August 6, 2024 09:20

Escape the angle brackets which are breaking links

c64e548

Apply suggestions from review

dc3bdf9

Co-authored-by: Kyle Rollins <115574589+krollins-mdb@users.noreply.github.com>

dacharyc requested a review from krollins-mdb August 6, 2024 13:28

krollins-mdb approved these changes Aug 6, 2024

View reviewed changes

dacharyc merged commit 8f7001a into mongodb:feature-consolidated-sdk-docs Aug 6, 2024
10 checks passed

dacharyc deleted the DOCSP-39516 branch August 6, 2024 15:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(DOCSP-39516): Consolidate Delete page #3336

(DOCSP-39516): Consolidate Delete page #3336

Uh oh!

dacharyc commented Jul 23, 2024 •

edited by krollins-mdb

Loading

Uh oh!

netlify bot commented Jul 23, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jul 23, 2024 •

edited

Loading

Uh oh!

krollins-mdb left a comment

Uh oh!

krollins-mdb Aug 5, 2024

Uh oh!

krollins-mdb Aug 5, 2024

Uh oh!

krollins-mdb Aug 5, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krollins-mdb left a comment

Uh oh!

Uh oh!

docs-builder-bot commented Aug 6, 2024

Uh oh!

Uh oh!

		for the objects you want to delete to :dotnet-sdk:`Realm.RemoveRange<T>
		<reference/Realms.Realm.html#Realms_Realm_RemoveRange__1_System_Linq_IQueryable___0__>`.

		To delete all objects of a type, call :dotnet-sdk:`Realm.RemoveAll<T>
		<reference/Realms.Realm.html#Realms_Realm_RemoveAll__1>`.

		In the following example, we call :dotnet-sdk:`Realm.RemoveRange<T>
		<reference/Realms.Realm.html#Realms_Realm_RemoveRange__1_System_Linq_IQueryable___0__>`

(DOCSP-39516): Consolidate Delete page #3336

(DOCSP-39516): Consolidate Delete page #3336

Uh oh!

Conversation

dacharyc commented Jul 23, 2024 • edited by krollins-mdb Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info - SDK Docs Consolidation

PR Author Checklist

Naming

Links and Refs

Content

Reviewer Checklist

Uh oh!

netlify bot commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for device-sdk ready!

Uh oh!

github-actions bot commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krollins-mdb left a comment

Choose a reason for hiding this comment

Uh oh!

krollins-mdb Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

krollins-mdb Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

krollins-mdb Aug 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krollins-mdb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

docs-builder-bot commented Aug 6, 2024

🪵 Logs

Uh oh!

Uh oh!

dacharyc commented Jul 23, 2024 •

edited by krollins-mdb

Loading

netlify bot commented Jul 23, 2024 •

edited

Loading

github-actions bot commented Jul 23, 2024 •

edited

Loading