Skip to content

(DOCSP-26999): Connect to App Services page #2526

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Jan 30, 2023
Merged

(DOCSP-26999): Connect to App Services page #2526

merged 8 commits into from
Jan 30, 2023

Conversation

mongodben
Copy link
Collaborator

@mongodben mongodben commented Jan 26, 2023 •
edited
Loading

Pull Request Info

@realm/react-ify RN 'Connect to App Services' page

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

@mongodben mongodben changed the base branch from master to realm-react-guidance January 26, 2023 21:45
@github-actions
Copy link

github-actions bot commented Jan 26, 2023 •
edited
Loading

Readability for Commit Hash: e0f8976

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

Flesch Reading Ease scores for changed documents:

  • source/sdk/react-native/app-services/connect-to-app-services-app: 69.28

The following table can be helpful in assessing the readability score of a document.

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

takameyer
takameyer approved these changes Jan 27, 2023
View reviewed changes
Copy link
Collaborator

@takameyer takameyer left a comment

Choose a reason for hiding this comment

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

Just a few things to clean up and this is good to go 👍🏼

krollins-mdb
krollins-mdb reviewed Jan 27, 2023
View reviewed changes
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.

Overall, looks great! Thanks, @mongodben!

I have a few comments/questions. Also, looks like the use-app.test.jsx test is failing. But the .tsx version is passing.

source/sdk/react-native/app-services/connect-to-app-services-app.txt Outdated

const id = "<Your App ID>"; // replace this with your App ID
.. tab::
:tabid: typescript
Copy link
Collaborator

Choose a reason for hiding this comment

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

[question] Is there any benefit to keeping tabs for TypeScript and JavaScript? The implementation is exactly the same between the two. I think just one sample would make sense. Again though, as we discussed only updating a minimum of things to get @realm/react changes up, take or leave as you see fit.

Also applies to tabs on line 54.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is there any benefit to keeping tabs for TypeScript and JavaScript?

i don't think so tbh. but the other @realm/reactified stuff does this as well.

you think we should go thru the whole updated branch and remove the unnec duplications?

w that being said, if we do that, would like to do it in a separate PR

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, I think it would be good to do, but we can probably do it later. It's not breaking anything right now. 😄

Copy link
Collaborator

Choose a reason for hiding this comment

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

I also think it would make sense to only display two tabs if the content is different.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

eh let's just do it now. i'll update

source/sdk/react-native/app-services/connect-to-app-services-app.txt Outdated

To retrieve an instance of the App Client from anywhere in your application, call :js-sdk:`Realm.App.getApp() <Realm.App.html#getApp>` and pass in your ``App ID``.
To retrieve an instance of the App Client from anywhere in your application,
call :js-sdk:`Realm.App.getApp() <Realm.App.html#getApp>` and pass in your ``App ID``.

.. tabs-realm-languages::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not getting syntax highlighting on either of these tabbed samples, but I'm not sure why.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it was b/c i forgot to put a linebreak before the code example

krollins-mdb
krollins-mdb approved these changes Jan 30, 2023
View reviewed changes
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.

Looks great, @mongodben!

Just one minor thing: we're inconsistent with single or double quotes on our imports. It seems common React Native convention is single quotes, but I'm not sure if this is something we've decided for/against in the past.

@mongodben mongodben merged commit ee416d7 into realm-react-guidance Jan 30, 2023
@mongodben mongodben deleted the DOCSP-26999 branch January 30, 2023 20:24
mongodben added a commit that referenced this pull request Feb 10, 2023
@mongodben @takameyer
(DOCSP-26999): Connect to App Services page (#2526)
fc70dec 
## Pull Request Info

@realm/react-ify RN 'Connect to App Services' page

### Jira

- https://jira.mongodb.org/browse/DOCSP-26999

### Staged Changes

- [Connect to App Services (React
Native)](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26999/sdk/react-native/app-services/connect-to-app-services-app)

### Reminder Checklist

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

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

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

---------

Co-authored-by: Andrew Meyer <[email protected]>
mongodben added a commit that referenced this pull request Mar 21, 2023
@mongodben @takameyer
(DOCSP-26999): Connect to App Services page (#2526)
551fe50 
## Pull Request Info

@realm/react-ify RN 'Connect to App Services' page

### Jira

- https://jira.mongodb.org/browse/DOCSP-26999

### Staged Changes

- [Connect to App Services (React
Native)](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-26999/sdk/react-native/app-services/connect-to-app-services-app)

### Reminder Checklist

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

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

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

---------

Co-authored-by: Andrew Meyer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@takameyer takameyer takameyer approved these changes

@krollins-mdb krollins-mdb krollins-mdb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mongodben @takameyer @krollins-mdb