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.

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

chore(docs): merge mobile SDK API docs #13840

Merged
merged 49 commits into from
Jul 30, 2023
Merged

chore(docs): merge mobile SDK API docs #13840

merged 49 commits into from
Jul 30, 2023

Conversation

ally-sassman
Copy link
Contributor

@ally-sassman ally-sassman commented Jul 13, 2023 •
edited
Loading

Changes include:

  1. Combine native and hybrid SDK API content into a singular "Mobile SDK" with tabs for each app framework.
  2. Replace hybrid SDK API content with a link out to the mobile SDK guide.
  3. Remove all other references of deleted URLs.

@ally-sassman
feat(docs): first round of edits
04cad41 
Drafted new singular mobile sdk api doc
@ally-sassman ally-sassman self-assigned this Jul 13, 2023
@github-actions
Copy link

Hi @ally-sassman 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Gatsby Cloud will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes).

@gatsby-cloud
Copy link

gatsby-cloud bot commented Jul 18, 2023 •
edited
Loading

✅ docs-website-develop deploy preview ready

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 134 to 137
```
recordBreadcrumb:(NSString* __nonnull)name attributes:(NSDictionary* __nullable)attributes;
NewRelic.recordBreadcrumb(string $Name, map $eventAttributes)
```
Copy link
Contributor Author

@ally-sassman ally-sassman Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Should this be formatted to obj-c or swift?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated

## Requirements

Agent version 5.13.0 or higher.
Copy link
Contributor Author

@ally-sassman ally-sassman Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Can you confirm this version number is correct?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated

## Requirements

Agent version 5.13.0 or higher.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you confirm this version number is correct?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 254 to 255
## Requirements

Copy link
Contributor Author

@ally-sassman ally-sassman Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a capacitor version requirement to use this call?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 311 to 312
## Requirements

Copy link
Contributor Author

@ally-sassman ally-sassman Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a cordova version requirement to use this call?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 369 to 370
## Requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a flutter version requirement to use this call?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 426 to 427
## Requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a react version requirement to use this call?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 484 to 485
## Requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a xamarin version requirement to use this call?

ally-sassman
ally-sassman commented Jul 18, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
Comment on lines 548 to 549
## Requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndesai-newrelic Is there a .NET MAUI version requirement to use this call?

ally-sassman
ally-sassman commented Jul 19, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
## Syntax

```csharp
RecordBreadcrumb(string name, Dictionary<string, object> attributes): bool;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
RecordBreadcrumb(string name, Dictionary<string, object> attributes): bool;
recordBreadcrumb(string name, Dictionary<string, object> attributes): bool;

ally-sassman
ally-sassman commented Jul 19, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk-api/record-breadcrumb.mdx Outdated
## Syntax

```csharp
RecordBreadcrumb(string name, Dictionary<string, object> attributes): bool;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
RecordBreadcrumb(string name, Dictionary<string, object> attributes): bool;
recordBreadcrumb(string name, Dictionary<string, object> attributes): bool;

nwhite222
nwhite222 reviewed Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/cross-app-tracing.mdx Outdated
redirects:
---

## Manual cross application tracing [#manual-cat]
Copy link
Contributor

Choose a reason for hiding this comment

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

This h2 looks a little clunky right next to the page title. Could it be preceded by some of the intro text?/ Is it necessary enough to include that it should replace the main title?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, if this process is Android-specific, could that be made a bit clearer?

nwhite222
nwhite222 reviewed Jul 28, 2023
View reviewed changes
Copy link
Contributor

@nwhite222 nwhite222 left a comment

Choose a reason for hiding this comment

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

Reiterating Shawn's comments, this is super impressive work!! I mostly made suggestions for clarity &small fixes.

ally-sassman
ally-sassman commented Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-application-version.mdx Outdated

### Objective-c [#objc]

```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
```
```objectivec

ally-sassman
ally-sassman commented Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-application-version.mdx Outdated

### Swift [#swift]

```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
```
```swift

ally-sassman
ally-sassman commented Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-attribute.mdx Outdated

### Objective-c [#objc]

```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
```
```objectivec

ally-sassman
ally-sassman commented Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-attribute.mdx Outdated

### Swift [#swift]

```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
```
```swift

ally-sassman
ally-sassman commented Jul 28, 2023
View reviewed changes
src/content/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-max-event-buffer-time.mdx Outdated
Comment on lines 116 to 119
## Return values [#return-values]

Returns `true` if it succeeds, or `false` if it doesn't.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
## Return values [#return-values]
Returns `true` if it succeeds, or `false` if it doesn't.

@ally-sassman @ndesai-newrelic @nwhite222
fix(docs): Apply suggestions from code review
043ba5b 
Co-authored-by: ndesai-newrelic <[email protected]>
Co-authored-by: Natasha White <[email protected]>
@ally-sassman ally-sassman reopened this Jul 29, 2023
@ally-sassman ally-sassman merged commit 864430a into develop Jul 30, 2023
10 of 12 checks passed
@ally-sassman ally-sassman deleted the mobile-SDK-docs branch July 30, 2023 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndesai-newrelic ndesai-newrelic ndesai-newrelic left review comments

@nwhite222 nwhite222 nwhite222 left review comments

@mbruin-NR mbruin-NR mbruin-NR left review comments

@paperclypse paperclypse paperclypse left review comments

Assignees

@ally-sassman ally-sassman

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ally-sassman @paperclypse @ndesai-newrelic @nwhite222 @mbruin-NR @sunnyzanchi