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

Docs: Person profiles updates #8271

Merged
merged 26 commits into from
May 31, 2024
Merged

Docs: Person profiles updates #8271

merged 26 commits into from
May 31, 2024

Conversation

ivanagas
Copy link
Contributor

@ivanagas ivanagas commented Apr 15, 2024

Changes

To support the launch of events with person profiles, updating relevant docs. Closes #8265

Notes

  • I wanted to use "person properties" everywhere which would unify the term, but some of our SDKs hardcode "user properties" into their structure and methods, making it a confusing split. Adding to this confusion is the fact we do use a mix of "person property" and "user property" throughout. I decided not make a big change in this PR.
  • As is being discussed, it feels like the case of events with person profiles relatively weak. A lot of functionality seems to work the exact same, which helps limit the amount of docs updates needed. For example, identify and funnels don't really need updates if usage remains consistent.

Checklist

  • Words are spelled using American English
  • Titles are in sentence case
  • Feature names are in sentence case too
  • Use relative URLs for internal links
  • If I moved a page, I added a redirect in vercel.json

Article checklist

  • I've checked the preview build of the article

Useful resources

@ivanagas ivanagas self-assigned this Apr 15, 2024
Copy link

vercel bot commented Apr 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
posthog ✅ Ready (Inspect) Visit Preview May 30, 2024 4:03pm

@ivanagas
Copy link
Contributor Author

Ok, this is in a pretty good spot at the moment. Will wait for the meeting tomorrow morning before opening up to proper reviews.

@ivanagas ivanagas changed the title Docs: Person profiles updates (WIP) Docs: Person profiles updates Apr 29, 2024
contents/docs/_snippets/identify-intro.mdx Outdated Show resolved Hide resolved
@@ -1,3 +1,3 @@
You'll notice that one of the parameters in the `identify` method is a `properties` object. This enables you to set [user properties](/docs/getting-started/user-properties). Whenever possible, we recommend passing in all user properties you have available each time you call identify, as this ensures their user profile on PostHog is up to date.
You'll notice that one of the parameters in the `identify` method is a `properties` object. If you are capturing person profiles, this enables you to set [user properties](/docs/getting-started/user-properties). Whenever possible, we recommend passing in all user properties you have available each time you call identify, as this ensures their person profile on PostHog is up to date.
Copy link
Contributor

Choose a reason for hiding this comment

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

I do feel that, with this change, we should try to standardise person properties or user properties as one term. Otherwise it's going to be confusing to users.

I don't have a strong feeling here as to which one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, my plan is to standardize on person properties after we merge this PR.

contents/docs/data/cohorts.mdx Outdated Show resolved Hide resolved
contents/docs/data/persons.mdx Outdated Show resolved Hide resolved
Co-authored-by: Joe Martin <84011561+joethreepwood@users.noreply.github.com>
Copy link
Member

@raquelmsmith raquelmsmith left a comment

Choose a reason for hiding this comment

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

Thanks for doing this @ivanagas!!

contents/docs/_snippets/how-to-link-events-to-groups.mdx Outdated Show resolved Hide resolved
contents/docs/_snippets/identify-intro.mdx Outdated Show resolved Hide resolved
contents/docs/api/capture.mdx Outdated Show resolved Hide resolved
contents/docs/data/cohorts.mdx Outdated Show resolved Hide resolved
contents/docs/libraries/java/index.mdx Outdated Show resolved Hide resolved
contents/docs/libraries/js/_snippets/identify.mdx Outdated Show resolved Hide resolved
contents/docs/product-analytics/identify.mdx Outdated Show resolved Hide resolved
contents/docs/product-analytics/identify.mdx Show resolved Hide resolved
contents/docs/product-analytics/user-properties.mdx Outdated Show resolved Hide resolved
Co-authored-by: Raquel Smith <raquelmsmith@users.noreply.github.com>
contents/docs/data/cohorts.mdx Outdated Show resolved Hide resolved
contents/docs/data/persons.mdx Outdated Show resolved Hide resolved
Co-authored-by: Andy Vandervell <92976667+andyvan-ph@users.noreply.github.com>
contents/docs/api/capture.mdx Outdated Show resolved Hide resolved
@@ -188,6 +188,21 @@ You can view whether a user can be merged into another user using `alias` when [

> Note that when calling `alias` in the frontend SDKs, if you have set any properties onto the anonymous user, they will be merged into the user with `distinct_id`. For more details, see the FAQ on [how properties are managed when identifying anonymous users](/docs/data/identify#how-are-properties-managed-when-identifying-anonymous-users).

## Processing person profiles
Copy link
Contributor

Choose a reason for hiding this comment

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

Longer term it would be nice if all person related content would be in person.mdx or similar so it's easy to know where to go and change things and other places include relevant snippets.

@raquelmsmith raquelmsmith merged commit 05ae4e9 into master May 31, 2024
3 checks passed
@raquelmsmith raquelmsmith deleted the person-profiles-docs branch May 31, 2024 17:19
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.

Personless Docs / Tutorials Updates
6 participants