If you'd like to edit a doc, click Edit this page. On GitHub, edit the file and submit your pull request. A member of the Tech Docs team will review your edit and publish your changes. We'll follow up with you if we have any questions.
If your draft needs to be released on a specific date or within a specific timeframe (for example, right before a release), contact the Tech Docs
@hero in the
#documentation Slack channel. If you're not a New Relic employee, please create a GitHub issue.
To edit existing content without building the site locally:
- Find a doc you'd like to edit.
- Click Edit this page.
- Make your changes.
- Write a meaningful commit message and description, then commit your change.
- Create your pull request.
A member of the Tech Docs team will let you know when we've published your changes.
- Clone the repo on your computer.
/src/content/docs/, find a good location for your doc.
- Using your text editor, create a new
.mdxfile or copy an existing doc.
- Write your content.
- Commit your changes and create a pull request.
The Tech Docs team has two heroes watching for new pull requests. We'll help you get the content finalized and make sure that it's in the right place.
Once you've cloned the
docs-website repository, use your text editor to copy an existing doc. Rename and edit the copy and then save it as a new doc.
If you want your cloned doc to be translated, follow standard procedures to request translation.
Your cloned doc automatically inherits the original doc's frontmatter content. Make sure to change that, too.
For docs work related to unreleased features, please use our private repo (Internal New Relic link)
If you create a new doc and submit a pull request in the private Docs repo and then contact the Tech Docs
@hero in the #documentation Slack channel.
The Tech Docs hero will follow up with you to get any additional details needed so that we can get this content published at the right time.
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's data security and licenses documentation.