• /
  • Log in
  • Free account

Create and edit content

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.

Important

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.

Edit and publish existing content

To edit existing content without building the site locally:

  1. Find a doc you'd like to edit.
  2. Click Edit this page.
  3. Make your changes.
  4. Write a meaningful commit message and description, then commit your change.
  5. Create your pull request.

A member of the Tech Docs team will let you know when we've published your changes.

Create new docs

You can use article templates or clone an existing doc as a template. To create a new doc:

  1. Clone the repo on your computer.
  2. In /src/content/docs/, find a good location for your doc.
  3. Using your text editor, create a new .mdx file or copy an existing doc.
  4. Write your content.
  5. 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.

Clone (copy) an existing doc

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.

Request a future publication date (for New Relic employees)

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.

Add or update license documentation

To add or update New Relic license information, follow standard procedures to add or update documentation in the appropriate Licenses category on the Docs site.

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.