Skip to content

Commit

Permalink
feat: update documentation directing contributors to use the sanitize…
Browse files Browse the repository at this point in the history
…-dashboard script when adding new dashboards
  • Loading branch information
clarkmcadoo committed Oct 28, 2021
1 parent 53abc94 commit 295e02d
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can search for all the available quickstarts in the [New Relic Instant Obser

With [New Relic One dashboards](https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards/) you can customize and understand the data you collect. Explore your data and correlate connected sources with tailored, user-friendly charts, and quickly learn the state of your system and applications for faster, more efficient troubleshooting.

> You can't copy/paste a dashboard's json directly from the repository to create a dashboard within New Relic. You will need to add "permissions": "PUBLIC_READ_WRITE",to the json prior to adding the dashboard to your account.
> You can't copy/paste a dashboard's json directly from the repository to create a dashboard within New Relic. Use the `sanitize-dashboard` script to remove any unneeded keys within the .json file, as well as setting the `accountId` to 0. EX: `yarn sanitize-dashboard node/express` where the argument is the path to the dashboard directory. The script will handle the rest.
### 📟 Alerts

Expand All @@ -52,6 +52,7 @@ Contribute your own quickstart to the New Relic One catalog by following the ste
4. In your new directory, you'll find the following folders: `dashboards`, `alerts` and `images`. Each folder contains a template or template directories that you can use to create entities for your quickstart.

- For example, to add an existing dashboard to your quickstart, [copy the dashboard's JSON](https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/manage-your-dashboard/#dash-json), and save it as a JSON file in the `dashboards` directory. Next, create a screenshot of your dashboard, add it to `dashboards`, and give it the same name as your JSON file.

- The `images` folder should contain images you want to display within a markdown widget on your Dashboard. An example of this would be the [Python quickstart](https://github.com/newrelic/newrelic-quickstarts/blob/main/quickstarts/python/python/dashboards/python.png) which includes image widgets defined using markdown. For more information on this see our docs on [creating widgets containing markdown text](https://docs.newrelic.com/docs/query-your-data/explore-query-data/dashboards/manage-your-dashboard/#markdown)

- You can add multiple JSON files and screenshots to `dashboards`. Pair each screenshot with a JSON file by using the same file name. If you want multiple screenshots for a dashboard, add a number at the end of the file name. So, your `dashboards` folder might contain:
Expand All @@ -67,22 +68,22 @@ Contribute your own quickstart to the New Relic One catalog by following the ste

2. Commit your changes using the [Conventional Commit syntax](./CONTRIBUTING.md#using-conventional-commits):

```sh
git add -A
git commit -m "feat([name]): Added [name]"
```
```sh
git add -A
git commit -m "feat([name]): Added [name]"
```

3. Push your changes to Github:

```sh
git push
```
```sh
git push
```

4. [Create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) in the [parent repository](https://github.com/newrelic/newrelic-quickstarts/compare?expand=1).

5. Submit and wait for review. Please be available to resolve review feedback in a timely manner.

**NOTE:** All contributions are public and available for use by others. When contributing, make sure the NRQL queries you use match the datasets the users have. You don't want to use NRQL queries with sensitive data.
**NOTE:** All contributions are public and available for use by others. When contributing, make sure the NRQL queries you use match the datasets the users have. You don't want to use NRQL queries with sensitive data.
## Testing
Expand All @@ -104,11 +105,14 @@ We've included an `importer` utility for testing quickstarts on your account. Yo
# Example
> ./import.sh mysql
```
If your quickstart is in a sub-directory please include that too for example `python/flask`
```
# Example
> ./import.sh python/flask
```

If your quickstart is in a sub-directory please include that too for example `python/flask`

```
# Example
> ./import.sh python/flask
```

## Support

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:
Expand All @@ -132,4 +136,3 @@ If you believe you have found a security vulnerability in this project or any of
## License

New Relic One quickstarts is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.

0 comments on commit 295e02d

Please sign in to comment.