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-34585): Clarify details about the different ways of connecting with Edge Server #642

Merged
merged 4 commits into from
Dec 4, 2023

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Dec 4, 2023

Pull Request Info

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

Staged changes:

  • Connect to an Edge Server: Move the "connect" section from the Use MongoDB APIs with Edge Server page so all the connection info is together. Add details about the different ways you can connect - via Device SDK or the MongoDB connection URI.
  • Use MongoDB APIs with Edge Server: Remove the "Connect" section, add a link to its new location on the "Connect" page.

Reminder Checklist

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

  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for corresponding docs-realm updates, if any

Release Notes

  • Edge Server
    • Connect to Edge Server: Move the "connect" section from the "Use MongoDB APIs with Edge Server" page. Add details about the different ways you can connect - via Device SDK or the MongoDB connection URI.
    • Use MongoDB APIs with Edge Server: Remove the "connect" section. Link to its new location on the "Connect to Edge Server" page.

Review Guidelines

REVIEWING.md

source/edge-server/connect.txt Outdated Show resolved Hide resolved
@@ -33,6 +48,18 @@ To connect to the Edge Server from a client, your app must:
you can coordinate with your Product or Account Representative to configure
HTTPS with a self-signed certificate.

For information about customizing the App configuration, refer to the
documentation for your preferred SDK:
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion

Suggested change
documentation for your preferred SDK:
documentation for your preferred SDK language:

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Flutter, .NET, and React Native aren't languages - they're frameworks. I don't think "SDK language" is something we can use here while we're still conflating the two things.

@dacharyc dacharyc merged commit a0d4e79 into mongodb:master Dec 4, 2023
4 checks passed
@dacharyc dacharyc deleted the DOCSP-34585 branch December 4, 2023 21:44
@docs-builder-bot
Copy link

MongoCaleb pushed a commit to MongoCaleb/docs-app-services that referenced this pull request Jun 3, 2024
… with Edge Server (mongodb#642)

* Move wire protocol connection details to 'Connect' page

* Add details about the different ways you can connect

* Apply suggestion from review

Co-authored-by: cbullinger <[email protected]>

---------

Co-authored-by: cbullinger <[email protected]>
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