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-39147): Update SPM install instructions and privacy manifest details #3237

Merged
merged 4 commits into from
May 1, 2024

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented May 1, 2024

Pull Request Info

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

  • Install: Update the Swift Package Manager and Privacy Manifest sections with information about building as a dynamic framework and linking only to one package.
  • Test and Debug: Add info for the error related to linking to both Realm and RealmSwift.

Reminder Checklist

Before merging your PR, make sure to check a few things.

  • Did you tag pages appropriately?
    • genre
    • meta.keywords
    • meta.description
  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for related docs-app-services work, if any

Release Notes

  • Swift SDK
    • Install: Update the Swift Package Manager and Privacy Manifest sections with information about building as a dynamic framework and linking only to one package.
    • Test and Debug: Add information about how to resolve an error related to linking to both Realm and RealmSwift.

Review Guidelines

REVIEWING.md

Copy link

github-actions bot commented May 1, 2024

Readability for Commit Hash: 65ba6b0

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

Readability scores for changed documents:

  • source/sdk/swift/install: Grade Level: 6.2, Reading Ease: 69.28
  • source/sdk/swift/test-and-debug: Grade Level: 7.4, Reading Ease: 66.13

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.

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

LGTM! A few minor suggestions for clarity.

To use the Privacy Manifest supplied by the SDK, build ``RealmSwift``
as a dynamic framework. If you build ``RealmSwift`` as a static
framework, you must supply your own Privacy Manifest. To build
``RealmSwift`` as a dynamic framework:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Minor suggestion: Maybe move "To build RealmSwift as a dynamic framework:" to a new line so that it offsets the procedural stuff a bit. Makes it easier to scan the page and pick up what the procedure is about.

@@ -272,3 +280,35 @@ Bad Alloc/Not Enough Memory Available
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. include:: /includes/ios-ipados-bad-alloc.rst

.. _swift-package-target-10-40-3-change:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is the 10-40-3 supposed to reference the SDK version? If so, wouldn't it be 10-49-3? I may be misunderstanding the purpose of this ref.

1. In your project :guilabel:`Targets`, select your build target.
2. Go to the :guilabel:`Build Phases` tab.
3. Expand the :guilabel:`Link Binary With Libraries` element.
4. Select either ``Realm`` or ``RealmSwift``, and click the :guilabel:`-` to
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this an icon button in Xcode? Does it have alt text? This looks like a typo when rendered to the page.

If there's alt text, can we do something like "click the button (:guilabel:`-`)"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hah, Cory usually tells me to remove "button" when I use it (old habit from old MMOS). I have never seen the alt text display, but I'm sure there must be some - let me see what I can figure out.

2. Go to the :guilabel:`Build Phases` tab.
3. Expand the :guilabel:`Link Binary With Libraries` element.
4. Select either ``Realm`` or ``RealmSwift``, and click the :guilabel:`-` to
remove the unneeded binary. For details about which binary to link with,
Copy link
Collaborator

Choose a reason for hiding this comment

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

The "with" here confused me a bit. Can we go with "link" by itself?

Suggested change
remove the unneeded binary. For details about which binary to link with,
remove the unneeded binary. For details about which binary to link,

@dacharyc dacharyc merged commit e7bba77 into mongodb:master May 1, 2024
6 checks passed
@dacharyc dacharyc deleted the DOCSP-39147 branch May 1, 2024 18:56
@docs-builder-bot
Copy link

docs-builder-bot commented May 1, 2024

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.

4 participants