diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-03-24 12:07:33 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-03-24 12:07:33 +0300 |
commit | a2bf9980c8254a41edb0e0b6d9eb4d8f0cd0fc69 (patch) | |
tree | 0ace1ad6a4efa7f3a36969ec25393cb9e0f09c9a /doc/development/product_qualified_lead_guide | |
parent | 647e9a6eed1d6cc29b62e432f89ed8260fd773a5 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/product_qualified_lead_guide')
-rw-r--r-- | doc/development/product_qualified_lead_guide/index.md | 42 |
1 files changed, 35 insertions, 7 deletions
diff --git a/doc/development/product_qualified_lead_guide/index.md b/doc/development/product_qualified_lead_guide/index.md index 6943f931d79..763fb1b7cd7 100644 --- a/doc/development/product_qualified_lead_guide/index.md +++ b/doc/development/product_qualified_lead_guide/index.md @@ -10,6 +10,41 @@ The Product Qualified Lead (PQL) funnel connects our users with our team members A hand-raise PQL is a user who requests to speak to sales from within the product. +## Set up your development environment + +1. Set up GDK with a connection to your local CustomersDot instance. +1. Set up CustomersDot to talk to a staging instance of Platypus. + +1. Set up CustomersDot using the [normal install instructions](https://gitlab.com/gitlab-org/customers-gitlab-com/-/blob/staging/doc/setup/installation_steps.md). +1. Set the `CUSTOMER_PORTAL_URL` env var to your local (or ngrok) URL of your CustomersDot instance. +1. Place `export CUSTOMER_PORTAL_URL='https://XXX.ngrok.io/'` in your shell rc script (~/.zshrc or ~/.bash_profile or ~/.bashrc) and restart GDK. +1. Enter the credentials on CustomersDot development to Platypus in your `/config/secrets.yml` and restart. Credentials for the Platypus Staging are in the 1Password Growth vault. The URL for staging is `https://staging.ci.nexus.gitlabenvironment.cloud`. + +```yaml + platypus_url: "<%= ENV['PLATYPUS_URL'] %>" + platypus_client_id: "<%= ENV['PLATYPUS_CLIENT_ID'] %>" + platypus_client_secret: "<%= ENV['PLATYPUS_CLIENT_SECRET'] %>" +``` + +### Set up lead monitoring + +1. Set up access for Platypus Staging `https://staging.ci.nexus.gitlabenvironment.cloud` using the Platypus Staging credentials in the 1Password Growth vault. +1. Set up access for the Marketo sandbox, similar [to this example request](https://gitlab.com/gitlab-com/team-member-epics/access-requests/-/issues/13162). + +### Manually test leads + +1. Register a new user with a unique email on your local GitLab instance. +1. Send the PQL lead by submitting your new form or creating a new trial or a new hand raise lead. +1. Use easily identifiable values that can be easily seen in Platypus staging. +1. Observe the entry in the staging instance of Platypus and paste in the merge request comment and mention. + +## Troubleshooting + +- Check the application and Sidekiq logs on `gitlab.com` and CustomersDot to monitor leads. +- Check the `leads` table in CustomersDot. +- Set up staging credentials for Platypus, and track the leads on the [Platypus Dashboard](https://staging.ci.nexus.gitlabenvironment.cloud/admin/queues/queue/new-lead-queue). +- Ask for access to the Marketo Sandbox and validate the leads there, [to this example request](https://gitlab.com/gitlab-com/team-member-epics/access-requests/-/issues/13162). + ## Embed a hand-raise lead form [HandRaiseLeadButton](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/assets/javascripts/hand_raise_leads/hand_raise_lead/components/hand_raise_lead_button.vue) is a reusable component that adds a button and a hand-raise modal to any screen. @@ -162,10 +197,3 @@ sequenceDiagram Workato->>Marketo: [lead] Marketo->>Salesforce(SFDC): [lead] ``` - -## Monitor and manually test leads - -- Check the application and Sidekiq logs on `gitlab.com` and CustomersDot to monitor leads. -- Check the `leads` table in CustomersDot. -- Set up staging credentials for Platypus, and track the leads on the [Platypus Dashboard](https://staging.ci.nexus.gitlabenvironment.cloud/admin/queues/queue/new-lead-queue). -- Ask for access to the Marketo Sandbox and validate the leads there. |