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

Add documentation to the Tracking package #20595

Merged
merged 5 commits into from
Aug 9, 2021
Merged

Conversation

leogermani
Copy link
Contributor

Adds a README file to the Tracking package along with documentation on how to use it.

Fixes #15929
Fixes #17569

Changes proposed in this Pull Request:

  • Adds a README file to the Tracking package along with documentation on how to use it.

Jetpack product discussion

n/a

Does this pull request change what data or activity we track or use?

No

Testing instructions:

Proofread the documentation

  • Ajax and PHP tracking were recently tested by me
  • I tested pixel tracking a long time ago. It should still be working the same way
  • Please confirm that the console command is the right one

@leogermani leogermani added Docs [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Aug 6, 2021
@leogermani leogermani added this to the jetpack/10.1 milestone Aug 6, 2021
@leogermani leogermani self-assigned this Aug 6, 2021
@github-actions github-actions bot added the [Package] Tracking This package no longer exists in the monorepo. It was merged into [Package] Connection. label Aug 6, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Aug 6, 2021

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ All commits were linted before commit.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

@leogermani leogermani requested a review from kbrown9 August 6, 2021 21:23
jeherve
jeherve previously requested changes Aug 9, 2021
projects/packages/tracking/README.md Outdated Show resolved Hide resolved
projects/packages/tracking/README.md Outdated Show resolved Hide resolved
@jeherve jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Aug 9, 2021
leogermani and others added 3 commits August 9, 2021 08:52
Co-authored-by: Jeremy Herve <jeremy@jeremy.hu>
Co-authored-by: Jeremy Herve <jeremy@jeremy.hu>
@leogermani leogermani added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Aug 9, 2021
@leogermani leogermani dismissed jeherve’s stale review August 9, 2021 11:58

changes applied

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Aug 9, 2021
@leogermani leogermani merged commit 285cd20 into master Aug 9, 2021
@leogermani leogermani deleted the add/tracks-docs branch August 9, 2021 18:14
@leogermani leogermani removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs [Package] Tracking This package no longer exists in the monorepo. It was merged into [Package] Connection.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tracking: add a README for the package Tracking Package / tools: consolidate and document available tools
2 participants