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

DOCSP-34421 Update Example Projects Page #3082

Merged
merged 8 commits into from
Nov 28, 2023

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented Nov 16, 2023

Pull Request Info

  • Intelligent Cache (.NET)
  • In-App Purchases (Swift)

Jira

Staged Changes

Reminder Checklist

If your PR modifies the docs, you might need to also update some corresponding
pages. Check if completed or N/A.

  • Create Jira ticket for corresponding docs-app-services update(s), if any
  • Checked/updated Admin API
  • Checked/updated CLI reference

Review Guidelines

REVIEWING.md

Copy link
Collaborator

@dacharyc dacharyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a couple of small questions.

@@ -133,6 +133,10 @@ Check out these supplementary projects to build on the power of Realm with Atlas
- Run Atlas Search queries with autocomplete and compound search terms by using an aggregation pipeline.
- - `.NET <https://github.com/realm/realm-dotnet-samples/tree/main/AtlasSearch>`__

* - Intelligent Cache
- Use Atlas as an intelligent cache against an external service to simplify data synchronization with the help of Atlas Device Sync.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention that this uses Triggers, Functions, and the Data API? I don't know if we've been mentioning the App Services features in the descriptions.

I'm also wondering if we should mention this uses Maui. I'm wondering if it's useful for people who are looking for "Maui" examples. It looks like we do mention SwiftUI in some of the other example descriptions, so that makes a stronger case for mentioning Maui here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added MAUI and Triggers, thanks! Have been only mentioning the main app services tools for the project in the description to keep it brief.

@lindseymoore lindseymoore changed the title DOCSP-34421 Add .NET project to Example Projects DOCSP-34421 Update Example Projects Page Nov 22, 2023
Copy link
Collaborator

@dacharyc dacharyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broadly this LGTM. But since this seems to be adding two new examples, should we also add cards for these examples to the .NET and Swift landing pages, respectively?

Also, Q for you on the meta:keywords directive.

@@ -4,6 +4,13 @@
Realm Example Projects
======================

.. meta::
:keywords: code examples
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no code examples on this page, so I'm not sure this should have the code examples meta tag. I thought we said that things that link out to other pages shouldn't be tagged with the thing directly. Since this is just a reference table, I don't think this applies?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair, removed!

Copy link
Collaborator Author

@lindseymoore lindseymoore Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For projects on the landing page, we currently have a selection of 3 or 4 example projects on the landing page for each SDK, along with a link to the full example projects page. I think this keeps the page concise!

Copy link

github-actions bot commented Nov 27, 2023

Readability for Commit Hash: a430f00

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

Readability scores for changed documents:

  • source/sdk/dotnet: Grade Level: 9.3, Reading Ease: 50.53
  • source/sdk/swift: Grade Level: 9.6, Reading Ease: 49.62

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.

@lindseymoore lindseymoore merged commit d0b0d28 into mongodb:master Nov 28, 2023
5 checks passed
@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.

3 participants