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 Node.js DI documentation page #27150

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

watson
Copy link
Contributor

@watson watson commented Jan 16, 2025

What does this PR do? What is the motivation?

  1. Add a Node.js page to the Dynamic Instrumentation documentation.
  2. Update the other language pages to match changes I've done to the shared "template".

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

Copy link
Contributor Author

watson commented Jan 16, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@watson watson force-pushed the watson/DEBUG-2755/add-nodejs-docs branch 5 times, most recently from cbf951a to 4cb79c7 Compare January 16, 2025 13:32
<div class="alert alert-info"><p><strong>Dynamic Instrumentation for Node.js is currently in limited preview!</strong></p><p>It is not available to all customers. To join the waiting list, <a href="https://forms.gle/TODO" target="_blank">fill out this form</a>.</p><p>Certain limitations apply to the limited preview. See <a href="#limitations">Limitations</a> for more information.</p></div>

{{< beta-callout-private url="https://forms.gle/TODO" >}}
<p><strong>Dynamic Instrumentation for Node.js is currently in limited preview!</strong></p>

Choose a reason for hiding this comment

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

Can we go with the copy from this version of the callout, but use the styling for the callout shown on this page? (That BigQuery preview callout was given as an example in a PM "how-to" doc for previewing products)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found a bunch of variations of that one. I've just pushed a commit with all of them so we can view them next to each other. We can edit the default text "Join the preview" to whatever we like and we can hide or show the button as we please.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For reference, this is how the callout is currently rendered on the Google BigQuery page:

image

When I render the exact same callout in the preview for this page, the background has a different color:

image

I don't know if this is just a difference between staging and production or if this is because of where in the page hierarchy the callout is rendered. However, using the callout snippet, it's not possible to manually change the background color.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've adjusted to copy and layout slightly to work better with the general rendering of the callout - let me know what you think:

image

@watson watson force-pushed the watson/DEBUG-2755/add-nodejs-docs branch 2 times, most recently from b7c81e0 to 5c79b36 Compare January 17, 2025 11:26
@watson watson force-pushed the watson/DEBUG-2755/add-nodejs-docs branch from 5c79b36 to 5267746 Compare January 17, 2025 12:30
Comment on lines +73 to +75
Dynamic Instrumentation for Node.js is currently in limited preview, which means it is not available to all customers. To join the waiting list, [fill out this form][6].

The following limitations apply to the limited preview:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sstonehill12 I'm considering just dropping one or both of these paragraphs. The first paragraph is already included in the callout at the top of the page and the second doesn't really add any value. Let me know what you think.

@watson watson force-pushed the watson/DEBUG-2755/add-nodejs-docs branch from e7231f4 to 5267746 Compare January 17, 2025 13:11
@watson watson force-pushed the watson/DEBUG-2755/add-nodejs-docs branch from 5267746 to dc71835 Compare January 17, 2025 19:08
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.

2 participants