diff --git a/README.md b/README.md index 091940f..7eb6de8 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,6 @@ ![CI](https://github.com/newrelic/nr1-groundskeeper/workflows/CI/badge.svg) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/newrelic/nr1-groundskeeper?include_prereleases&sort=semver) [![Snyk](https://snyk.io/test/github/newrelic/nr1-groundskeeper/badge.svg)](https://snyk.io/test/github/newrelic/nr1-groundskeeper) - - -This application is maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [starting a discussion](../../discussions) in this repo. - ## Usage **Note:** Version 2.6 with Distributed Tracing ingest estimator available now. @@ -22,50 +18,35 @@ This application will help you keep up to date with the latest agent versions an ![Screenshot #1](catalog/screenshots/nr1-groundskeeper-1.png) -## Open Source License - -This project is distributed under the [Apache 2 license](LICENSE). - ## Dependencies Requires [`New Relic APM`](https://newrelic.com/products/application-monitoring). -## Getting started +## Enabling this App -First, ensure that you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [NPM](https://www.npmjs.com/get-npm) installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized): +This App is available via the New Relic Catalog. -```bash -git --version -npm -v -``` +To enable it in your account: +1. go to `Add Data > Apps and Visualzations` and search for "Groundskeeper" +2. Click the `Groundskeeper` card, and then click the `Add this App` button to add it to your account(s) +3. Click `Open App` to launch the app (note: on the first time accessing the app, you may be prompted to enable it) -Next, clone this repository and run the following scripts: +Once you have added your accounts, you can also open the app by: +1. Open the `Apps` left-hand navigation menu item (you may need to click on the `Add More` ellipsis if it doesn't show up by default) +2. In the `Your Apps` section, locate and click on the `Groundskeeper` card to open the app -```bash -nr1 nerdpack:clone -r https://github.com/newrelic/nr1-groundskeeper.git -cd nr1-groundskeeper -nr1 nerdpack:serve -``` +#### Manual Deployment +If you need to customize the app, fork the codebase and follow the instructions on how to [Customize a Nerdpack](https://developer.newrelic.com/build-apps/customize-nerdpack). If you have a change you feel everyone can benefit from, please submit a PR! -Visit [https://one.newrelic.com/?nerdpacks=local](https://one.newrelic.com/?nerdpacks=local), navigate to the Nerdpack, and :sparkles: +## Support -## Deploying this Nerdpack - -Open a command prompt in the nerdpack's directory and run the following commands. - -```bash -# To create a new uuid for the nerdpack so that you can deploy it to your account: -# nr1 nerdpack:uuid -g [--profile=your_profile_name] + -# To see a list of APIkeys / profiles available in your development environment: -# nr1 profiles:list +This project is actively maintained by the New Relic Labs team. Connect with us directly by [creating issues](../../issues) or [asking questions in the discussions section](../../discussions) of this repo. -nr1 nerdpack:publish [--profile=your_profile_name] -nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name] -nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name] -``` +We also encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas. -Visit [https://one.newrelic.com](https://one.newrelic.com), navigate to the Nerdpack, and :sparkles: +New Relic has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. ## Community Support @@ -89,3 +70,7 @@ If you believe you have found a security vulnerability in this project or any of Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself :grin:). Please review our [Contributors Guide](CONTRIBUTING.md). Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com. + +## Open Source License + +This project is distributed under the [Apache 2 license](LICENSE).