[ONPREM-2094] Add contribution guidelines (#42)

* Add table of contents to README

* Add contribution guidelines

Author: christian-stephen

.circleci/config.yml

@@ -73,7 +73,7 @@ jobs:
           name: Dashboards failed linting or validation
           command: |
             echo "Please refer to the documentation here:"
-            echo "https://github.com/circleci-public/circleci-server-monitoring-reference?tab=readme-ov-file#8-modifying-or-adding-grafana-dashboards"
+            echo "https://github.com/circleci-public/circleci-server-monitoring-reference?tab=readme-ov-file#modifying-or-adding-grafana-dashboards"
             exit 1
           when: on_fail
       - notify_failing_main

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing Guidelines
+
+Contributions are always welcome; however, please read this document in its entirety before submitting a pull request or reporting a bug.
+
+## Table of Contents
+
+- [Reporting a bug](#reporting-a-bug)
+  - [Security disclosure](#security-disclosure)
+- [Creating an issue](#creating-an-issue)
+- [Opening a pull request](#opening-a-pull-request)
+- [License](#license)
+
+---
+
+## Reporting a Bug
+
+Think you've found a bug? Let us know by following the instructions in our [bug reporting guide](https://support.circleci.com/hc/en-us/articles/360054033532-How-can-I-report-a-bug).
+
+### Security Disclosure
+
+Security is a top priority for us. If you have encountered a security issue, please responsibly disclose it by following our [security disclosure](https://circleci.com/docs/2.0/security/) document.
+
+## Creating an Issue
+
+Your issue must follow these guidelines for it to be considered:
+
+### Before Submitting
+
+- Check you’re on the latest version, we may have already fixed your bug!
+- [Search our issue tracker](https://github.com/circleci-public/circleci-server-monitoring-reference/issues/search&type=issues) for your problem, someone may have already reported it.
+
+## Opening a Pull Request
+
+To contribute, [fork](https://help.github.com/articles/fork-a-repo/) `circleci-server-monitoring-reference`, commit your changes, and [open a pull request](https://help.github.com/articles/using-pull-requests/).
+
+Your request will be reviewed as soon as possible. You may be asked to make changes to your submission during the review process.
+
+### Before Submitting
+
+- Test your change thoroughly. Deploy it to your own CircleCI server environment to ensure it works as expected. You can find instructions on how to deploy in the [Installing the Monitoring Stack](https://github.com/CircleCI-Public/circleci-server-monitoring-reference?tab=readme-ov-file#installing-the-monitoring-stack) section of our README.
+- Utilize the `./do` script to assist in your testing workflow. Here are some examples of how you can use it:
+  ```bash
+  # Run the Helm unit tests
+  ./do unit-tests
+
+  # Lint the dashboards
+  ./do lint-dashboards
+
+  # See a full list of available options
+  ./do help
+  ```
+- If updating or modifying a Grafana dashboard, ensure to follow the instructions in the [README](https://github.com/circleci-public/circleci-server-monitoring-reference?tab=readme-ov-file#modifying-or-adding-grafana-dashboards).
+
+## License
+
+CircleCI's `circleci-server-monitoring-reference` is released under the [Apache 2.0 License](./LICENSE).

README.md

@@ -5,6 +5,13 @@ A reference for tools, configurations, and documentation used to monitor CircleC
 
 This repository is currently under active development and is not yet a supported resource. Please refer to it at your own discretion until further notice.
 
+## Table of Contents
+
+- [Installing the Monitoring Stack](#installing-the-monitoring-stack)
+- [Modifying or Adding Grafana Dashboards](#modifying-or-adding-grafana-dashboards)
+- [Helm Values](#values)
+- [Helm Releases](#releases)
+
 # server-monitoring-stack
 
 A reference Helm chart for setting up a monitoring stack for CircleCI server
@@ -122,7 +129,7 @@ grafana:
 ```
 > **_NOTE:_** Use a custom storage class with a 'Retain' policy to allow for data retention even after uninstalling the chart.
 
-### 8. Modifying or Adding Grafana Dashboards
+## Modifying or Adding Grafana Dashboards
 
 The default dashboards are located in the `dashboards` directory of the reference chart. To add new dashboards or modify existing ones, follow these steps.
 
@@ -137,7 +144,7 @@ Dashboards are provisioned directly from CRDs, which means any manual edits will
 3. **Export as JSON**:
    - Select **Export** in the upper right corner and then **Export as JSON**.
    - **Ensure that `Export the dashboard to use in another instance` is toggled on.**
-4. **Run Validation Command**:
+4. **Update the JSON File**:
    - Download the file and replace the `./dashboards/server-slis.json` file with the updated copy.
    - Run the following command to automatically validate the JSON and apply necessary updates:
      ```bash
@@ -205,6 +212,6 @@ Dashboards are provisioned directly from CRDs, which means any manual edits will
 | prometheusOperator.prometheusConfigReloader.image.tag | string | `"v0.80.1"` | Tag for the Prometheus Config Reloader image. |
 | prometheusOperator.replicas | int | `1` | Number of Prometheus Operator replicas to deploy. |
 
-## Releasing
+## Releases
 
 Releases are managed by the CI/CD pipeline on the main branch, with an approval job gate called `approve-deploy-chart`. Before releasing, increment the Helm chart version in `Chart.yaml` and regenerate the documentation using `./do helm-docs`. Once approved, the release will be available in the [package repository](https://packagecloud.io/circleci/server-monitoring-stack).

README.md.gotmpl

@@ -5,6 +5,13 @@ A reference for tools, configurations, and documentation used to monitor CircleC
 
 This repository is currently under active development and is not yet a supported resource. Please refer to it at your own discretion until further notice.
 
+## Table of Contents
+
+- [Installing the Monitoring Stack](#installing-the-monitoring-stack)
+- [Modifying or Adding Grafana Dashboards](#modifying-or-adding-grafana-dashboards)
+- [Helm Values](#values)
+- [Helm Releases](#releases)
+
 {{ template "chart.header" . }}
 {{ template "chart.description" . }}
 
@@ -116,7 +123,7 @@ grafana:
 ```
 > **_NOTE:_** Use a custom storage class with a 'Retain' policy to allow for data retention even after uninstalling the chart.
 
-### 8. Modifying or Adding Grafana Dashboards
+## Modifying or Adding Grafana Dashboards
 
 The default dashboards are located in the `dashboards` directory of the reference chart. To add new dashboards or modify existing ones, follow these steps.
 
@@ -131,7 +138,7 @@ Dashboards are provisioned directly from CRDs, which means any manual edits will
 3. **Export as JSON**:
    - Select **Export** in the upper right corner and then **Export as JSON**.
    - **Ensure that `Export the dashboard to use in another instance` is toggled on.**
-4. **Run Validation Command**:
+4. **Update the JSON File**:
    - Download the file and replace the `./dashboards/server-slis.json` file with the updated copy.
    - Run the following command to automatically validate the JSON and apply necessary updates:
      ```bash
@@ -143,6 +150,6 @@ Dashboards are provisioned directly from CRDs, which means any manual edits will
 
 {{ template "chart.valuesSection" . }}
 
-## Releasing
+## Releases
 
 Releases are managed by the CI/CD pipeline on the main branch, with an approval job gate called `approve-deploy-chart`. Before releasing, increment the Helm chart version in `Chart.yaml` and regenerate the documentation using `./do helm-docs`. Once approved, the release will be available in the [package repository](https://packagecloud.io/circleci/server-monitoring-stack).