Skip to content

[Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥#445

Open
sumitramanga wants to merge 1 commit intomasterfrom
sm/SS-607/update-user-tracking-docs-to-reference-customers
Open

[Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥#445
sumitramanga wants to merge 1 commit intomasterfrom
sm/SS-607/update-user-tracking-docs-to-reference-customers

Conversation

@sumitramanga
Copy link
Contributor

@sumitramanga sumitramanga commented Feb 3, 2021

[Customers Product]: Change references from 'User tracking' to 'Customers' 👤

NOTE: This is not to be merged until we have fully released the name change in the Raygun application. Changes to 'users' within the code needs to be discussed and planned for.

Description 📝

This PR is to updating the name convention for 'User tracking' to now be 'Customers' to reflect what's within the Raygun application.

Updates
👉 Update README documentation
👉 Update readme.txt documentation

Test plan 🧪

  • Make sure documentation changes are reflected to be 'Customers' instead of 'User Tracking'

Checklist ✔️

  • Builds pass
  • Reviewed by another developer
  • Code is written to standards

@sumitramanga sumitramanga changed the title [Customers Product]: Change references from 'User tracking' to 'Customers' 👥 [Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥 Feb 3, 2021
@sumitramanga sumitramanga changed the title [Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥 [Customers Product]: Change references from 'Users' to 'Customers' within documentation 👥 Feb 3, 2021
There is a property named *User* on RaygunClient which you can set to be the current user's ID or email address.
This allows you to see the count of affected users for each error in the Raygun dashboard.
If you provide an email address, and the user has an associated Gravatar, you will see their avatar in the error instance page.
There is a property named *User* on RaygunClient which you can set to be the current customers's ID or email address.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: customers's

```Identifier``` is the unique identifier from your system for this customer.

```IsAnonymous``` is a flag indicating whether the user is logged in (or identifiable) or if they are anonymous. An anonymous user can still have a unique identifier.
```IsAnonymous``` is a flag indicating whether the customer is logged in (or identifiable) or if they are anonymous. An anonymous user can still have a unique identifier.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it intentional the "user" is still mentioned on this line?

There is a property named ```User``` on RaygunClient which you can set to be the current cusrtomer's ID. This allows you to see the count of affected customers for each error in the Raygun dashboard.

If you want more detailed information about users (and the ability to use the new Affected User reporting feature when it is released), you can set the ```UserInfo``` property on the RaygunClient to a new RaygunIdentifierMessage object. [This class](https://github.com/MindscapeHQ/raygun4net/blob/master/Mindscape.Raygun4Net/Messages/RaygunIdentifierMessage.cs) has a number of properties on it to help identifier the user who experienced a crash.
If you want more detailed information about customers (and the ability to use the new Customers feature when it is released), you can set the ```UserInfo``` property on the RaygunClient to a new RaygunIdentifierMessage object. [This class](https://github.com/MindscapeHQ/raygun4net/blob/master/Mindscape.Raygun4Net/Messages/RaygunIdentifierMessage.cs) has a number of properties on it to help identifier the customer who experienced a crash.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need to mention "(and the ability to use the new Customers feature when it is released)" anymore

Copy link
Contributor

@QuantumNightmare QuantumNightmare left a comment

Choose a reason for hiding this comment

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

Pointed out a typo that we best fix. A few other comments to consider.

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.

2 participants