chore: Updated all references to internal api docs and point to the g… #18448
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ithub hosted links. Also removed redundant snippets with links to robust example applications
|
Hi @bizob2828 👋 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). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rhetoric101
reviewed
Aug 26, 2024
There was a problem hiding this comment.
@bizob2828 I took a swing through the docs and made some suggestions. Could you review these?
src/content/docs/apm/agents/nodejs-agent/api-guides/nodejs-agent-api.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/api-guides/nodejs-agent-api.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/api-guides/guide-using-nodejs-agent-api.mdx
Outdated
Show resolved
Hide resolved
.../agents/nodejs-agent/extend-your-instrumentation/nodejs-v1-custom-instrumentation-legacy.mdx
Show resolved
Hide resolved
...docs/apm/agents/nodejs-agent/installation-configuration/distributed-tracing-nodejs-agent.mdx
Outdated
Show resolved
Hide resolved
...docs/apm/agents/nodejs-agent/installation-configuration/distributed-tracing-nodejs-agent.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/installation-configuration/install-nodejs-agent.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/apm/agents/nodejs-agent/installation-configuration/update-nodejs-agent.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Rob Siebens <rsiebens@newrelic.com>
rhetoric101
added
content
rhetoric101
approved these changes
Aug 27, 2024
Thanks for reviewing this @rhetoric101! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…ithub hosted links. Also removed redundant snippets with links to robust example applications
Please follow conventional commit standards
in your commit messages and pull request title.
Give us some context
We had fragmented documentation around using the Node.js agent. The Node.js agent team has spent a lot of time building out examples. This PR updates most code snippets with links to functioning example applications.
Also, we had redundant information around the Node.js agent API. We host an API docs site and it gets updated on every release. This is the most recent information and any information documenting statically in docs-website could get out of date. This PR also updates any links to API methods to use the
newrelic.github.iolinks.Links
Closes newrelic/node-newrelic#2468