Skip to content

Commit 3a85466

Browse files
remram44FxKu
andauthored
DOC: Fix formatting of bullet points (#2948)
Co-authored-by: Felix Kunde <felix-kunde@gmx.de>
1 parent eddf521 commit 3a85466

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/administrator.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,14 @@ from numerous escape characters in the latter log entry, view it in CLI with
195195
used internally in K8s.
196196

197197
The StatefulSet is replaced if the following properties change:
198+
198199
- annotations
199200
- volumeClaimTemplates
200201
- template volumes
201202

202203
The StatefulSet is replaced and a rolling updates is triggered if the following
203204
properties differ between the old and new state:
205+
204206
- container name, ports, image, resources, env, envFrom, securityContext and volumeMounts
205207
- template labels, annotations, service account, securityContext, affinity, priority class and termination grace period
206208

@@ -898,6 +900,7 @@ services:
898900
There are multiple options to specify service annotations that will be merged
899901
with each other and override in the following order (where latter take
900902
precedence):
903+
901904
1. Default annotations if LoadBalancer is enabled
902905
2. Globally configured `custom_service_annotations`
903906
3. `serviceAnnotations` specified in the cluster manifest

docs/developer.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ under the ~/go/src sub directories.
1616

1717
Given the schema above, the Postgres Operator source code located at
1818
`github.com/zalando/postgres-operator` should be put at
19-
-`~/go/src/github.com/zalando/postgres-operator`.
19+
`~/go/src/github.com/zalando/postgres-operator`.
2020

2121
```bash
2222
export GOPATH=~/go
@@ -105,13 +105,15 @@ and K8s-like APIs for its custom resource definitions, namely the
105105
Postgres CRD and the operator CRD. The usage of the code generation follows
106106
conventions from the K8s community. Relevant scripts live in the `hack`
107107
directory:
108+
108109
* `update-codegen.sh` triggers code generation for the APIs defined in `pkg/apis/acid.zalan.do/`,
109110
* `verify-codegen.sh` checks if the generated code is up-to-date (to be used within CI).
110111

111112
The `/pkg/generated/` contains the resultant code. To make these scripts work,
112113
you may need to `export GOPATH=$(go env GOPATH)`
113114

114115
References for code generation are:
116+
115117
* [Relevant pull request](https://github.com/zalando/postgres-operator/pull/369)
116118
See comments there for minor issues that can sometimes broke the generation process.
117119
* [Code generator source code](https://github.com/kubernetes/code-generator)
@@ -315,6 +317,7 @@ precedence.
315317

316318
Update the following Go files that obtain the configuration parameter from the
317319
manifest files:
320+
318321
* [operator_configuration_type.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/operator_configuration_type.go)
319322
* [operator_config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/controller/operator_config.go)
320323
* [config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config.go)
@@ -323,13 +326,15 @@ Postgres manifest parameters are defined in the [api package](https://github.com
323326
The operator behavior has to be implemented at least in [k8sres.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres.go).
324327
Validation of CRD parameters is controlled in [crds.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/crds.go).
325328
Please, reflect your changes in tests, for example in:
329+
326330
* [config_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config_test.go)
327331
* [k8sres_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres_test.go)
328332
* [util_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/util_test.go)
329333

330334
### Updating manifest files
331335

332336
For the CRD-based configuration, please update the following files:
337+
333338
* the default [OperatorConfiguration](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml)
334339
* the CRD's [validation](https://github.com/zalando/postgres-operator/blob/master/manifests/operatorconfiguration.crd.yaml)
335340
* the CRD's validation in the [Helm chart](https://github.com/zalando/postgres-operator/blob/master/charts/postgres-operator/crds/operatorconfigurations.yaml)
@@ -342,6 +347,7 @@ Last but no least, update the [ConfigMap](https://github.com/zalando/postgres-op
342347

343348
Finally, add a section for each new configuration option and/or cluster manifest
344349
parameter in the reference documents:
350+
345351
* [config reference](reference/operator_parameters.md)
346352
* [manifest reference](reference/cluster_manifest.md)
347353

0 commit comments

Comments
 (0)