docs-preview.newrelic.com
Welcome! 👋 this is the repo for the NEW New Relic Docs site.
Currently this repo contains all the Docs website source code and Markdown source files we're using to build our preview Docs site: docs-preview.newrelic.com. When it's ready, all of our production documentation will be found in this repo.
Read on to learn more about who we are and how you can contribute to the New Relic Docs site.
New Relic Developer and Open Source sites
You may also be interested in the New Relic Developer website and Open Source website repos.
We'd like your help
From early on, our Docs site has been managed by a team of writers. We've always welcomed contributions from anyone at New Relic and 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. Open sourcing our docs seemed like a great way to expand this conversation beyond New Relic.
We're here working every day to improve our docs and we'd love to hear from you. Come join the conversation.
Get started
On each page of our docs, you can create an issue or edit a page.
Create an issue
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.
Edit a page
If you'd like to get more directly involved, you can make some changes yourself. On any doc, click the Edit this page button to get started making a change. You can edit a doc directly on the GitHub site. You don't need to actively fork the site or build it locally to help out. This is the easiest way to contribute. If you'd like to go deeper, see our Contributors guide for information on how to fork our site, build it locally, and submit pull requests.
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 your technical insight and knowhow. Let us handle the little details for you.
🚧 Contributing
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.
🏛️ Content and code license
- 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.