Skip to content

Commit

Permalink
Refactor tables of content (#2103)
Browse files Browse the repository at this point in the history
  • Loading branch information
albertogdd authored Sep 11, 2023
1 parent 3ff5d58 commit 78c086c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 27 deletions.
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
- [Contributing](#contributing)
- [Unit tests](#unit-tests)
- [E2E tests](#e2e-tests)
- [Useful commands](#useful-commands)
- [Remove all Dynatrace pods in force mode (useful debugging E2E tests)](#remove-all-dynatrace-pods-in-force-mode-useful-debugging-e2e-tests)
- [Copy CSI driver database to localhost for introspection via sqlite command](#copy-csi-driver-database-to-localhost-for-introspection-via-sqlite-command)
- [Add debug suffix on E2E tests to avoid removing pods](#add-debug-suffix-on-e2e-tests-to-avoid-removing-pods)
- [Debug cluster nodes by opening a shell prompt (details here)](#debug-cluster-nodes-by-opening-a-shell-prompt-details-here)

# Contributing

- [Steps](#steps)
- [Unit tests](#unit-tests)
- [E2E tests](#e2e-tests)
- [Useful commands](#useful-commands)
- [Remove all Dynatrace pods in force mode (useful debugging E2E tests)](#remove-all-dynatrace-pods-in-force-mode-useful-debugging-e2e-tests)
- [Copy CSI driver database to localhost for introspection via sqlite command](#copy-csi-driver-database-to-localhost-for-introspection-via-sqlite-command)
- [Add debug suffix on E2E tests to avoid removing pods](#add-debug-suffix-on-e2e-tests-to-avoid-removing-pods)
- [Debug cluster nodes by opening a shell prompt (details here)](#debug-cluster-nodes-by-opening-a-shell-prompt-details-here)

## Steps

1. Read the [coding style guide](doc/coding-style-guide.md).

2. Fork the dynatrace-operator repository and get the source code:
Expand Down
35 changes: 17 additions & 18 deletions doc/coding-style-guide.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# Coding style guide

- [Coding style guide](#coding-style-guide)
- [General](#general)
- [Function Parameter and Return-Value Order](#function-parameter-and-return-value-order)
- [Cuddling of statements](#cuddling-of-statements)
- [Reconciler vs Controller](#reconciler-vs-controller)
- [A **Controller** is a struct that **DIRECTLY** handles the reconcile Requests](#a-controller-is-a-struct-that-directly-handles-the-reconcile-requests)
- [A **Reconciler** is a struct that **INDIRECTLY** handles the reconcile Requests](#a-reconciler-is-a-struct-that-indirectly-handles-the-reconcile-requests)
- [Errors](#errors)
- [Do's](#dos)
- [Don'ts](#donts)
- [Logging](#logging)
- [Do's](#dos-1)
- [Don'ts](#donts-1)
- [Testing](#testing)
- [Do's](#dos-2)
- [Don'ts](#donts-2)
- [E2E testing guide](#e2e-testing-guide)
- [Code Review](#code-review)
- [General](#general)
- [Function Parameter and Return-Value Order](#function-parameter-and-return-value-order)
- [Cuddling of statements](#cuddling-of-statements)
- [Reconciler vs Controller](#reconciler-vs-controller)
- [A **Controller** is a struct that **DIRECTLY** handles the reconcile Requests](#a-controller-is-a-struct-that-directly-handles-the-reconcile-requests)
- [A **Reconciler** is a struct that **INDIRECTLY** handles the reconcile Requests](#a-reconciler-is-a-struct-that-indirectly-handles-the-reconcile-requests)
- [Errors](#errors)
- [Do's](#dos)
- [Don'ts](#donts)
- [Logging](#logging)
- [Do's](#dos-1)
- [Don'ts](#donts-1)
- [Testing](#testing)
- [Do's](#dos-2)
- [Don'ts](#donts-2)
- [E2E testing guide](#e2e-testing-guide)
- [Code Review](#code-review)

## General

Expand Down

0 comments on commit 78c086c

Please sign in to comment.