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

Improving the Install page #7443

Merged
merged 13 commits into from
Jan 8, 2024
Merged

Improving the Install page #7443

merged 13 commits into from
Jan 8, 2024

Conversation

joethreepwood
Copy link
Contributor

Changes

One of my Q1 goals is improving the getting started content, so it makes sense to start here.

Screenshot 2024-01-04 at 11 09 15

The existing version (above) is...

  • Long
  • Verbose
  • Has a lot of different elements which draw the eye needlessly (e.g. two > sections + a code snippet)
  • Features info in a weird order (e.g only telling you to customize the snippet after telling you to paste it in, and only telling you there's a prefilled version after that)
  • Has links to both EU and US cloud even though we can replace these with a single link now
  • Is technically incorrect (e.g. telling you it captures video sessions and only then telling you to enable replays after and not giving a link)

It also doesn't mention that we recommend setting up a reverse proxy, even though we recommend doing this and it will soon feature as a step in @corywatilo's new onboarding flows.

Addressing these points gives us a much tidier, simpler install page while still giving us room to include the reverse proxy.

Screenshot 2024-01-04 at 11 09 44

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
  • Remove this template if you're not going to fill it out!

Article checklist

  • I've added (at least) 3-5 internal links to this new article
  • I've added keywords for this page to the rank tracker in Ahrefs
  • I've checked the preview build of the article
  • The date on the article is today's date
  • I've added this to the relevant "Tutorials and guides" docs page (if applicable)

Useful resources

@joethreepwood joethreepwood self-assigned this Jan 4, 2024
Copy link

vercel bot commented Jan 4, 2024

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

Name Status Preview Updated (UTC)
posthog 🛑 Canceled (Inspect) Jan 5, 2024 11:22am

Copy link
Contributor

@ivanagas ivanagas left a comment

Choose a reason for hiding this comment

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

Looks good, some tweaks (I realize some were there before your edits)


Paste this snippet within the `<head>` tags of your website - ideally just inside the closing `</head>` tag - on all pages that you wish to track.
Copy the snippet below and replace `<ph_project_api_key>` and `<ph_instance_address>` with your project's values, then add it within the `<head>` tags of your product - ideally just before the closing `</head>` tag - on pages you want to track.
Copy link
Contributor

Choose a reason for hiding this comment

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

One thing is the <ph_project_api_key> and instance_address get automatically filled if those details are available (I think by using the logged in cookie), so there is a chance someone sees this and they don't have those values below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm. Not sure I can see how we can accomodate that though. Probably best to leave it?


> **Tip**: Even if you have multiple customer-facing products e.g. a marketing website + iOS app + web app, it works best to have them share the same project to track the user across their journey. See: [Organizations & projects docs](/manual/organizations-and-projects)
> **Tip**: If you have multiple customer-facing products (e.g. a marketing website + iOS app + web app), it's best to install PostHog on them all and [group them in one project](/docs/data/organizations-and-projects). This way you can track the user across their entire journey.
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
> **Tip**: If you have multiple customer-facing products (e.g. a marketing website + iOS app + web app), it's best to install PostHog on them all and [group them in one project](/docs/data/organizations-and-projects). This way you can track the user across their entire journey.
> **Tip**: If you have multiple products (e.g. a marketing website + iOS app + web app), it's best to install PostHog on them all and [group them in one project](/docs/data/organizations-and-projects). This way you can track the user across their entire journey.

Copy link
Contributor

@ivanagas ivanagas left a comment

Choose a reason for hiding this comment

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

👍

@joethreepwood joethreepwood merged commit 568ec42 into master Jan 8, 2024
1 check passed
@joethreepwood joethreepwood deleted the add-proxy branch January 8, 2024 09:44
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