Node.js Added documentation and cross-link for Azure site extension

[mrickard]

Give us some context

• The Node Agent team has released the Azure Site Extension for Node, an easy-install path for customers deploying Code-based Web Apps to Windows on Azure. This adds documentation for this install path.

[github-actions]

Hi @mrickard 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

[netlify]

✅ Deploy Preview for docs-website-netlify ready!

Name	Link
🔨 Latest commit	4265e78
🔍 Latest deploy log	https://app.netlify.com/sites/docs-website-netlify/deploys/670d7b61fc5f7d0008fb56a2
😎 Deploy Preview	https://deploy-preview-18896--docs-website-netlify.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[akristen]

Hi @mrickard -- I'm moving this to our drafts column. Since it's a whole new install path, it may take at least three days or up to a sprint to review and complete, depending on the amount of validation and editing that needs to be done :) Please reach out to the hero when you're ready for review!!

[mrickard]

@akristen What would be the best debugging path to follow for those build/deploy failures? It looks as though things have changed significantly in this repo since I last submitted a PR. (Which is understandable!)

[mrickard]

The Vale linter seems to have a complaint or a failure here; I don't seem to be able to run it locally to understand what changes to make.

[akristen]

The Vale linter seems to have a complaint or a failure here; I don't seem to be able to run it locally to understand what changes to make.

I'll take a look! Our vale linter has been a little neurotic lately so it shouldn't be a blocker.

[mrickard]

@akristen Thank you! I'm also going to add a few changes to some related documents. Would it make more sense to do that as a separate PR, or load them in this one?

[akristen]

@akristen Thank you! I'm also going to add a few changes to some related documents. Would it make more sense to do that as a separate PR, or load them in this one?

Feel free to keep it all in this PR! (Or if separate is easier for you, that's fine too -- just be sure to leave a comment that links to this PR so we know it's related/connected.) I'm going to do a review right now for what's already here.

[akristen]

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:

• Child item 1
• Child item 2
  • gchild item 1
  • gchild item 2

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:

Once the site extension is installed, you'll need to manually enter one configuration item before restarting your application. From the Azure portal on the options listed on the left, find Settings and scroll down to Environment variables. Add the NEW_RELIC_LICENSE_KEY variable with your license key value.

The Node agent automatically adds the NODE_OPTIONS environment variable with a value of -r newrelic. This key-value pair starts the agent. Any previously defined NODE_OPTIONS will be removed and reset with -r newrelic.

[mrickard]

I definitely prefer the rewrite, though there's a slight tweak for accuracy that I'll add in the next commit.

[mrickard]

Thank you, @akristen ! I'm updating, and I'm also reversing my earlier consolidation: the site extension should really be its own page, crosslinked from the Azure hosting page, since it simplifies installation there. Updates incoming.

[akristen]

Is there a space between the 1 bullet and the snippet?

[mrickard]

There should be a line break, so the snippet gets rendered as a code block.

[akristen]

In the deploy preview, this section of text isn't flush as a child under the list. I'd shift tab both the code snippet and this piece of copy so it's nested underneath step 1.

[mrickard]

Ah, I wasn't sure how that got rendered. Let me try with my local copy...

[mrickard]

Finally fixed it! OK, hang on for a new commit.

[akristen]

It's best to lead procedures with a clear, direct action that needs to happen. If conceptual info is necessary to help people understand how to do it or why they're doing it, we should add that after the fact. This allows our power users to get to the meat of the procedure while prociding context for newer/less experienced users (that power users can skim past) For example, in step 1, we clearly tell them to "Add X to Y".

What is the action in its most distilled form here? Some suggestions:

• Add the Node.js ``-r/--require` flag to the `ENTRYPOINT` so the `newrelic` module appears first. Instrumentation is most reliable if the New Relic agent is required before your app starts. If your container setup doesn't allow this action, then try some of these alternatives:
  • something
  • something
  • something

[mrickard]

I have a proposed change I'll push in the next commit.

[akristen]

Can this be part of a separate h2 section at the start of the doc about versioning, instead of a callout? What's the benefit of it being a callout?

[mrickard]

This was a callout early on in this document probably because it's a warning to avoid exposing the license key in committed code.

[akristen]

LET'S GO! :)