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

feat: customize URL of Google Tag Manager #4369

Merged

Conversation

pepopowitz
Copy link
Collaborator

Description

Addresses #4351.

Uninstalls the 3rd-party plugin we were using (https://github.com/LukasGentele/docusaurus-gtm-plugin), and defines the plugin locally instead, with the ability to specify a tagManagerUrl.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. It should be merged after the upcoming 8.6 release, due to the potential risk introduced at this time.
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@pepopowitz pepopowitz added the dx Documentation infrastructure typically handled by the Camunda DX team label Sep 30, 2024
@pepopowitz pepopowitz self-assigned this Sep 30, 2024
@pepopowitz pepopowitz added the deploy Stand up a temporary docs site with this PR label Sep 30, 2024
Comment on lines -26 to -36
// ["@edno/docusaurus2-graphql-doc-generator",
// {
// schema: "http://localhost:8080/tasklist/graphql",
// rootPath: "./docs/", // docs will be generated under (rootPath/baseURL)
// baseURL: "apis-tools/tasklist-api",
// linkRoot: "/docs/",
// loaders: {
// UrlLoader: "@graphql-tools/url-loader"
// }
// },
// ],
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't know what this is or why were holding on to it, but I've been meaning to delete this for a long time 😅

id: "GTM-KQGNSTS", // GTM Container ID
containerId: "GTM-KQGNSTS",
tagManagerUrl:
process.env.TAG_MANAGER_URL || "https://ssgtm.camunda.com",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm letting the default value flow through for now; if we decide in the future that we want to change it again, we can do so by specifying an environment variable in GitHub.

Comment on lines +6 to +8
if (process.env.NODE_ENV !== "production") {
return null;
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This will prevent GTM from rendering when running locally. The plugin we're previously using doesn't do this, but it seems like the right thing to do.

@akeller
Copy link
Member

akeller commented Sep 30, 2024

It should be merged after the upcoming 8.6 release, due to the potential risk introduced at this time

My anxiety appreciates this.

@github-actions github-actions bot temporarily deployed to camunda-docs September 30, 2024 21:20 Destroyed
akeller
akeller previously approved these changes Oct 1, 2024
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

image

I'm not really sure how to test this, but I see it loads the URL, so I will approve.

@antantunes, would you be able to confirm this change is working as expected? Does this change need to go in parallel with the product? AFAIK, they have not received a request for this.

@pepopowitz pepopowitz added the hold This issue is parked, do not merge. label Oct 1, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs October 1, 2024 17:14 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs October 2, 2024 15:24 Destroyed
@pepopowitz pepopowitz requested a review from akeller October 2, 2024 18:54
@akeller
Copy link
Member

akeller commented Oct 7, 2024

Removing deploy since it's currently broken. 😢

@akeller akeller added deploy Stand up a temporary docs site with this PR and removed deploy Stand up a temporary docs site with this PR labels Oct 7, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs October 7, 2024 16:12 Destroyed
@akeller
Copy link
Member

akeller commented Oct 7, 2024

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

@pepopowitz pepopowitz removed the hold This issue is parked, do not merge. label Oct 8, 2024
@pepopowitz pepopowitz merged commit aebe1fb into main Oct 9, 2024
8 of 9 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/4351-request-change-url-of-google-tag-manager branch October 9, 2024 20:02
Copy link
Contributor

github-actions bot commented Oct 9, 2024

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants