The docs-website project is the code and data behind the new docs.newrelic.com. It is generated by Gatsby and built with the gatsby-theme-newrelic.
If you would like to make a contribution to the site, feel free to make a fork of the repository and follow the information below to get it running locally.
In order to run the project locally, you must have the following installed:
Yarn is used by the project for installing dependencies and running tasks. To install yarn, follow the steps on the yarn website. After installing yarn, you should no longer need to use npm for anything in the project.
You can serve this site locally to quickly see your changes and additions before you PR them. To get started, navigate into your new site’s directory and start it up, as follows.
git clone [email protected]:newrelic/docs-website.git
cd docs-website/
yarn
yarn startNew Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
Add the url for the support thread here
We encourage your contributions to improve docs-website! 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 [email protected].
- 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.