diff --git a/README.md b/README.md index 0ee6ebd..daa4b92 100644 --- a/README.md +++ b/README.md @@ -72,71 +72,26 @@ Example query: `FROM Transaction SELECT count(*) FACET appName, hourOf(timestamp - Set custom display values - On click to stacked entity or modal to many entities --- -## Open source license +# Enabling this Nerdpack -This project is distributed under the [Apache 2 license](LICENSE). - - -## Getting started - -This project is automatically available in the New Relic One Catalog under custom visualizations. If you would like to develop or deploy your own version follow the steps below. - -1. 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 commands. (If you have them installed, these commands return a version number; if not, the commands aren't recognized.) -```bash -git --version -npm -v -``` -2. Install the [NR1 CLI](https://one.newrelic.com/launcher/developer-center.launcher) by going to [the developer center](https://one.newrelic.com/launcher/developer-center.launcher), and following the instructions to install and set up your New Relic development environment. This should take about 5 minutes. -3. Execute the following command to clone this repository and run the code locally against your New Relic data: - -```bash -nr1 nerdpack:clone -r https://github.com/newrelic/nr1-status-widgets.git -cd nr1-status-widgets -nr1 nerdpack:serve -``` - -Visit [https://one.newrelic.com/?nerdpacks=local](https://one.newrelic.com/?nerdpacks=local) to launch your app locally. - -## Deploying this Nerdpack manually - -Open a command prompt in the app's directory and run the following commands. - -```bash -# If you need to create a new uuid for the account to which you're deploying this app, use the following -# nr1 nerdpack:uuid -g [--profile=your_profile_name] -# to see a list of APIkeys / profiles available in your development environment, run nr1 credentials:list -nr1 nerdpack:publish [--profile=your_profile_name] -nr1 nerdpack:tag [-t [CURRENT]] [--profile=your_profile_name] -``` +This pack of visualizations is available via the New Relic Catalog. -Visit [https://one.newrelic.com](https://one.newrelic.com), and launch your app in New Relic. +To enable it in your account, go to `Add Data > Apps and Visualzations` and search for "Status Widget Pack". Click the card and subscribe this to your accounts. -## Manual dashboard deployment +Once subscribed you can browse to `Apps -> Custom Visualizations` to [add any of the widgets to a dashboard](https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/add-custom-visualizations-your-dashboards/). -https://developer.newrelic.com/build-apps/build-visualization#deploy-and-use-your-visualization - -``` -This needs to be deployed into your account so that the custom visualizations can be added to dashboards. -After this has been deployed, ensure you navigate to the app and add to the account. -``` +#### Manual Deployment +If you need to customize the widgets in this pack, you can fork the code base 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](#contrib)! # Support -New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub. - -We 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. - -## Community - -New 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: - -https://discuss.newrelic.com/t/status-widget-visualizations-nerdpack-for-dashboards/154721 +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. -## Issues / enhancement requests +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. -Issues and enhancement requests can be submitted in the [Issues tab of this repository](../../issues). Please search for and review the existing open issues before submitting a new issue. +New Relic has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. -## Security +# Security As noted in our [security policy](https://github.com/newrelic/nr1-status-widget/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. @@ -147,3 +102,8 @@ If you believe you have found a security vulnerability in this project or any of Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. 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+statuswidgets@newrelic.com. + +# Open source license + +This project is distributed under the [Apache 2 license](LICENSE). +