Skip to content

Commit d916267

Browse files
docs(reamde): restructure table of contents
1 parent 5eefb0d commit d916267

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,16 @@ The Metrics Operator is a powerful tool designed to monitor and provide insights
99
- [Key Features](#key-features)
1010
- [Architecture Overview](#architecture-overview)
1111
- [Installation](#installation)
12+
- [Getting Started](#getting-started)
1213
- [Usage](#usage)
13-
- [RBAC Configuration](#rbac-configuration)
1414
- [Remote Cluster Access](#remote-cluster-access)
15+
- [RBAC Configuration](#rbac-configuration)
1516
- [DataSink Configuration](#datasink-configuration)
1617
- [Data Sink Integration](#data-sink-integration)
18+
- [Support, Feedback, Contributing](#support-feedback-contributing)
19+
- [Security / Disclosure](#security--disclosure)
20+
- [Code of Conduct](#code-of-conduct)
21+
- [Licensing](#licensing)
1722

1823
## Key Features
1924

@@ -142,6 +147,37 @@ Replace `<operator-namespace>` and `<version>` with appropriate values.
142147

143148
After deployment, create your DataSink configuration as described in the [DataSink Configuration](#datasink-configuration) section.
144149

150+
## Getting Started
151+
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
152+
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
153+
154+
### Running on the cluster
155+
1. Install Instances of Custom Resources:
156+
157+
```sh
158+
make dev-local-all
159+
```
160+
161+
2. Run the controller:
162+
163+
```sh
164+
make dev-run
165+
```
166+
Or run it from your IDE.
167+
168+
### Delete Kind Cluster
169+
Delete Kind cluster
170+
```sh
171+
make dev-clean
172+
```
173+
174+
### Modifying the API definitions
175+
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
176+
177+
```sh
178+
make manifests generate
179+
```
180+
145181
## Usage
146182

147183
### Metric
@@ -437,37 +473,6 @@ To make the most of your metrics:
437473
For specific instructions on using your data sink's features, refer to its documentation. For example, if using Dynatrace, consult the Dynatrace documentation for information on creating custom charts, setting up alerts, and performing advanced analytics on your metric data.
438474

439475

440-
## Getting Started
441-
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
442-
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
443-
444-
### Running on the cluster
445-
1. Install Instances of Custom Resources:
446-
447-
```sh
448-
make dev-local-all
449-
```
450-
451-
2. Run the controller:
452-
453-
```sh
454-
make dev-run
455-
```
456-
Or run it from your IDE.
457-
458-
### Delete Kind Cluster
459-
Delete Kind cluster
460-
```sh
461-
make dev-clean
462-
```
463-
464-
### Modifying the API definitions
465-
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
466-
467-
```sh
468-
make manifests generate
469-
```
470-
471476
## Support, Feedback, Contributing
472477

473478
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/metrics-operator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)