Working on Zendesk automations, triggers, macros, views, etc.

General process

To make it easier for Support Engineers to contribute to things that are managed by Support Operations, data and code have been separated for some items. This approach removes the need for Customer Support Operations to review every change proposed for Zendesk views, macros, triggers and automations.

For any changes to the content of Zendesk views, macros, triggers and automations consider their impact first. If your changes go beyond something like fixing a typo or updating a link and have broader repercussions for the team, consider the Change Management in GitLab Support handbook page. Otherwise you can suggest your changes directly via a merge request in the relevant managed content project.

For creating new content or renaming existing content (e.g. a new macro, or renaming a view), an STM issue is required as Customer Support Operations has to handle these actions. The managed content projects only allow managing content of existing items.

Managed content projects

Refer to the corresponding projects and create a merge request with your changes:

• gitlab-com/support/zendesk-global/automations
• gitlab-com/support/zendesk-global/macros
• gitlab-com/support/zendesk-global/triggers
• gitlab-com/support/zendesk-global/views
• gitlab-com/support/zendesk-us-government/automations
• gitlab-com/support/zendesk-us-government/macros
• gitlab-com/support/zendesk-us-government/triggers
• gitlab-com/support/zendesk-us-government/views
• gitlab-com/support/support-pages (also known as articles)

Whether you’re proposing minor changes directly or something bigger following an RFC discussion, tag a Support Manager for review and ask them to merge the changes. Once changes have been merged in one of these projects, you’ll notice that the Sync Stage badge says Awaiting Deployment on the project overview page. This indicates that there’s changes in the project that will be rolled out during the next regular deployment.

Quarterly Audits

At the start of every quarter, scripts will run in the sync repos checking for “orphaned” managed content files (i.e. files without a matching Zendesk item). If there are any of these, an issue will be made in the Support Team Meta project (pinging the groups/persons listed in the corresponding CODEOWNERS file).

The objective of these is to either delete files no longer in use or to raise issues with Customer Support Operations if a file is reported as “orphaned” but should still be in use.

Macros

• If you want to edit the wording of a macro, make an MR to the repo (Zendesk Global or Zendesk US Government).
• If you want to make non-wording changes (renaming it, add/removing options, etc.), use the Support Super Form ‘Edit a Zendesk macro’ option.
  • NOTE If a managed content file is needed (as you selected a Public or Private comment would be used), the Support Super Form will create a placeholder file for you (if said file does not exist). For the quickest resolution, it is best to not create the managed content file before your submission of the Support Super Form.
• If you want to deactivate a macro, use the Support Super Form ‘Edit a Zendesk macro’ option.
  • NOTE If the macro has a managed content file, only deactivate the file after Support Ops confirms the macro has been deactivated in Zendesk. This step is important to prevent sync errors in the ZD Macro repo.
• If you want to create a new macro, use the Support Super Form ‘Create a Zendesk macro’ option.
  • NOTE If a managed content file is needed (as you selected a Public or Private comment would be used), the Support Super Form will create a placeholder file for you (if said file does not exist). For the quickest resolution, it is best to not create the managed content file before your submission of the Support Super Form.
• To discuss a macro (but not actually action on anything), use a support-team-meta issue.

Organizations

Modifications to Zendesk organizations can be made through the use of the Support Super Form

• The Support Super Form will walk you through making your modification. If an option does not appear in the list of available choices, it cannot currently be modified.

To make changes to a Global organization’s note you would use the Zendesk Global Organizations project to modify an organizations notes.

For US Government Organizations, all organization notes are managed manually by the Customer Support Operations team. Due to the sensitive nature of the organizations, please reach out to Support operations via slack to make changes.

Previewing variable replacement

When using liquid variables it can be useful to verify that they will be working as you expect them to. A simple way to do this is to create a test ticket, pasting the content of your automation, trigger, or macro in there and observing the outcome.

View page source - Edit this page - please contribute.