We welcome your contributions, whether you are a New Relic employee or a New Relic user! 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.
Edit a doc
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 Docs team will review your edit and publish your changes. We'll follow up with you if we have any questions.
To edit existing content without building the site locally, check out this short video or follow the steps below:
- On the docs site, navigate to the doc you'd like to edit.
- Click Edit page on the top corner of the right nav.
- A GitHub page will open with the source of the doc. Click the pencil icon in the top right.
- Make your edits (don't worry too much about formatting or grammar, we're happy to take care of that).
- At the bottom of the page, enter a commit message that describes your change, then click Commit changes.
- Follow the prompts to submit your pull request.
A member of the Docs team will review your pull request and comment with any feedback. Once we've merged your pull request into the Develop branch, your changes will go live with our next release (usually within a few hours).
If you'd like to go deeper with development, see our Contributors guide for information on how to fork our site, build it locally, and submit pull requests.
Edit an existing branch
Do you want to contribute to an existing pull request? On GitHub, follow these steps:
- Create a fork of the docs repo.
- Commit your changes to the fork.
- Merge your PR into the active branch.
Watch the video for a more detailed walkthrough:
Create new docs
If you're unfamiliar with how to structure a new document, here are some tricks for getting started:
- Find a similar doc and use it as a guide to the layout.
- In the left navigation pane of the style guide, look under Doc types and templates for formatting tips.
To create a new doc:
- 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.
- Optional: Add your doc to the right nav
.ymlfile. The navigation files can be a bit hard to work with, so feel free to leave this step for a Docs writer to handle when they review your pull request.
- 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.
For bigger projects
If you're making larger changes like adding a whole new doc or editing many existing docs, it can be helpful to run the site locally. For instructions, see Tech writer workflow.
If you are comfortable with deleting the page yourself, go for it. Note that if a doc is marked for translation, we should also delete it in the
i18n folder. To request us to delete something:
- File an issue in the docs-website repo, or contact the @hero in the #help-documentation channel if you're a New Relic employee.
- We'll take a look at your issue and help out.
If you need to stage content for a preview, contact the docs hero in the #help-documentation Slack channel.
Request a future publication date (for New Relic employees)
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 #help-documentation Slack channel. If you're not a New Relic employee, please create a GitHub issue.