Skip to content
This repository was archived by the owner on Mar 6, 2025. It is now read-only.

Conversation

@nodehatch
Copy link
Contributor

@nodehatch nodehatch commented Aug 16, 2023

Description

What does this PR do?

PR checklist for examples

Check these items before merging the PR.

  • Each example contains a README file.
  • README documents all steps and variables required to run the example. The simplest way to confirm this is to follow the instructions on a clean machine.
  • README file contains the links to the official documentation with relevant configuration and to the metrics published if that is available.
  • Used images of apps and collectors have to be pinned, "latest" should never be used.
  • Evidences with screenshots provided from the reviewer.
  • Includes a file called metrics.csv with metrics produced by the example.
    The file should have these 5 headings: Name, Description, Unit, DataType, Attributes.
    Description is not provided for all metrics, so it may be blank. Attributes are also not always provided. When there are multiple attributes on a metric reord they should be space separated.
  • Dashboard provided with example and put to the folder "dashboard" inside the example folder.
  • At least one screenshot of the proposed dashboard is included in this PR. If you're proposing substantive changes to queries or new queries then please ensure your screenshot shows relevant data.
  • All chart names in the dashboard are in Title case.
  • All query names in the dashboard are lower case letters, beginning the first query of each chart as "a" and proceeding alphabetically ... "b", "c", etcetera.

@nodehatch nodehatch self-assigned this Aug 16, 2023
Copy link
Contributor

@altuner altuner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing dashboard and filled checklist

@nslaughter
Copy link
Contributor

missing dashboard and filled checklist

Good comment. Based on revisions to workflow we merged.

@nslaughter nslaughter requested a review from altuner August 23, 2023 20:07
@nslaughter
Copy link
Contributor

nslaughter commented Aug 23, 2023

missing dashboard and filled checklist

Missing dashboard is fine. And unfilled items on checklist pertain to dashboards.

@nslaughter nslaughter merged commit 58f51b3 into main Aug 23, 2023
@nslaughter nslaughter deleted the feat/collector/nats branch August 23, 2023 20:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants