Welcome! 👋 This is the repo for docs.newrelic.com. This repo contains all the source code and Markdown source files we use to build our docs site.
Read on to learn more about who we are and how you can contribute to the New Relic Docs site.
From the start, we've welcomed contributions from anyone at New Relic, not just writers. Now, we're open sourcing our docs to invite input from anyone at all. We credit our technical accuracy and comprehensive documentation to this openness.
In a sense, it's documentation as conversation. By making our docs open source, we hope to expand this conversation.
We're here working every day to improve our docs and we'd love to hear from you. Come join the conversation.
On each page of our docs, you can create an issue or edit a page.
Issues are a quick way to give us feedback about our docs. We'll review your issue and follow up with you if we have any questions. You can create an issue to let us know when you find an error or notice something missing. You can also let us know about things you'd like to see. Go here to create an issue.
If you'd like to get more directly involved, you can edit the docs yourself! Here's how:
- Every doc page on docs.newrelic.com has an Edit page pencil button in the right sidebar and the footer. Click it to access GitHub and the source file for that doc page.
- Make your changes, then click Commit changes. This will automatically create a fork in your GitHub account with the changes.
- Finally, follow the prompts to create a pull request and submit your changes for review.
From there our writers will check out your pull request, comment with any feedback, and merge your change.
If you'd like more information on how to edit our docs, read our processes to create and edit content. Additionally, our Style guide will give you some insight into how we think about writing and documentation, as well as our flavor of Markdown. Reading the style guide is totally optional! Our writers are here to make sure everything is formatted and worded right. We're looking for your technical insight and knowhow. Let us handle the little details for you.
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.
We welcome contributions to the New Relic Docs Site. Please review our Contributors Guide prior to submitting any code.
Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
You may also be interested in the New Relic Developer website and Open Source website repos.
- The content of New Relic product documentation in the
docs-websiterepository is licensed under a CC-BY-NC-SA 4.0 license. - Code, including sample code, contained in the
docs-websiterepository is licensed under the Apache 2.0 license. - When using New Relic logos, follow New Relic’s media assets guidelines.
- The
docs-websiteproject also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.