Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Node.js Added documentation and cross-link for Azure site extension #18896
Node.js Added documentation and cross-link for Azure site extension #18896
Changes from 6 commits
fd3f776
1ad9c59
41fd624
4949bca
30f3288
c562615
9902a20
73cedd2
ac6d70b
3afd5b9
ad74781
d528a3a
070a59e
e49f708
6abbaa4
0234668
c477376
00dd6d7
15a8d82
59fbc36
5d93c49
0033ac1
4387d9e
d753131
2c919bd
b268fa3
cbbbc6b
ce7bbfb
6cb12f8
4265e78
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lines 48-50 is hard to parse. Typically we want to reserve bulleted lists with child (and grand child lists) to follow this kind of pattern:
Sentence goes here:
Rather than a bunch of single bullets after single bullets. I think we can both make it readable and remove the lists so it looks something like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I definitely prefer the rewrite, though there's a slight tweak for accuracy that I'll add in the next commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we provide an example console command they can run to do all of this so it's one code block instead of several snippets? It might read something like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll rewrite this to note why you'd want to add the -r flag: it's to inject the agent before your application runs. Otherwise, you need to include the agent at the top of your entrypoint file, which is something people often overlook or have trouble with. The agent needs to be loaded before other dependencies run.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Step 2 with all the tips and notes can be adjusted with some tech writer copy edits. Is this step directing the agent to initialize when the container with app image spins up? I might rework it to read something like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the two entry point examples, we can make those child options for the examples
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a version I think is better for these; I'll be pushing that momentarily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as before. we have 5 callouts in this doc. Let's choose one to prioritize and nest relevant information within procedure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've also noticed that the first callout in this doc mixed up variant and tip. I'm in favor of one "tip," one "caution," and one "important."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be changed to regular text, but we should keep the caution call out... I'm wondering if that needs to be bumped up sooner?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm moving it earlier; let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These call outs about versioning makes me believe there should be a compatibility section with all of this content grouped together AHEAD of procedure. Having it dispersed throughout the doc can be confusing and break flow, and then customers can't go to one section for reference about versioning. Can we make these version callouts h2s with everything lumped together?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've moved these a bit--let me know how the next commit looks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've made a modified version of this to be more explicit about the naming: I could see some users just copying and pasting the
NEW_RELIC_FF_ENABLED
, though there's no guarantee that someone won't do that with the version I've just pushed.