Skip to content

Commit 458d9c1

Browse files
added table of contents
1 parent aa38612 commit 458d9c1

File tree

2 files changed

+34
-24
lines changed

2 files changed

+34
-24
lines changed

INSTALL.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Installation
2+
3+
This plugin gets installed through ```bitops.config.yaml``` in the bitops core level. This file is located [here](https://github.com/bitovi/bitops/blob/plugins/bitops.config.yaml)
4+
5+
6+
### Sample Config
7+
8+
```
9+
bitops:
10+
fail_fast: true
11+
run_mode: default
12+
logging:
13+
level: DEBUG
14+
color:
15+
enabled: true
16+
filename: bitops-run
17+
err: bitops.logs
18+
path: /var/logs/bitops
19+
opsrepo_root_default_dir: _default
20+
plugins:
21+
kubectl:
22+
source: https://github.com/bitops-plugins/kubectl
23+
...
24+
...
25+
...
26+
27+
```

README.md

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
11
# Bitops Plugin for Kubectl
22

3-
## Introduction
4-
This plugin will install ``kubectl`` cli.
3+
## Table of contents
54

6-
## Installation
5+
1. [Introduction](#Introduction)
6+
2. [Installation](https://github.com/bitops-plugins/kubectl/blob/main/INSTALL.md)
7+
3. [Deployment](#Deployment)
78

8-
This plugin gets installed through ```bitops.config.yaml```.
9+
---
910

10-
### Sample Config
11+
## Introduction
12+
This plugin will install ``kubectl`` cli.
1113

12-
```
13-
bitops:
14-
fail_fast: true
15-
run_mode: default
16-
logging:
17-
level: DEBUG
18-
color:
19-
enabled: true
20-
filename: bitops-run
21-
err: bitops.logs
22-
path: /var/logs/bitops
23-
opsrepo_root_default_dir: _default
24-
plugins:
25-
kubectl:
26-
source: https://github.com/bitops-plugins/kubectl
27-
...
28-
...
29-
...
3014

31-
```
3215

3316
## Deployment
3417

0 commit comments

Comments
 (0)