We welcome your contributions! And we don't want you to worry about style. When you edit a file, tech writers on our team review it for style, grammar, and formatting. That said, if you're curious about our style guidelines, you're welcome (but not obligated) to take a look.
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
in the #documentation Slack
channel. If you're not a
New Relic employee, please create a GitHub
If you see a minor problem in our documentation that you want to quickly fix, you can use GitHub to 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.
You need a GitHub account to edit docs. If you don’t have one, you can create it here.
To edit existing content without building the site locally:
- Find a doc you'd like to edit.
- Click Edit file on the top corner of the right nav.
- In the GitHub file, click on the pencil icon within the code block on the top right corner to access the markdown editor.
- Make your changes.
- Write a meaningful commit message and description, then commit your change by creating a new branch.
- Follow the prompts to submit your pull request. Please fill in as many details as possible in the provided template.
- And you're done!
A member of the Tech Docs team will let you know when we've published your changes.
- If you'd like to create an entirely new page of documentation, or move existing content, file a Documentation Request, or contact us in the
- The Documentation Team will review your request and follow up with you.
- If a new page is approved you may be asked to help write the page content.
- Follow the instructions above to submit a PR for your change.
- 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.
If you are comfortable with deleting the page yourself, go for it. If not, ask us by:
- File an issue in the docs-website repo, or contact the @hero in the #documentation channel if you're a New Relic employee.
- The Documentation Team will review the request to delete an existing documentation page.
- If the deletion is approved, the Docs team will delete the page.
If you have access to a private version of this repository, you can contribute and review content without sharing it publicly.
Note that, with all of these steps, if you have SSH Keys set up, you will want to use the SSH URL (not the HTTPS URL).
For docs work related to unreleased features, please use our beta 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.