Merge pull request #18 from lightstep/gtd.fix-readme

docs: fix readme generation

Author: gdvalle

charts/lightstepsatellite/README.md

@@ -29,7 +29,7 @@ Lightstep microsatellite to collect telemetry data.
 | lightstep.guid | string | `nil` | defaults to pod's name using the Downward API |
 | lightstep.http_plain_port | int | `8181` |  |
 | lightstep.http_secure_port | int | `9191` |  |
-| lightstep.max_msg_size_bytes | int | `0` | Max gRPC server message size the microsatellite will accept. A value of 0 means the gRPC default of 4MiB |
+| lightstep.max_msg_size_bytes | int | `0` | Configure max gRPC receive message size in bytes. https://pkg.go.dev/google.golang.org/grpc#MaxRecvMsgSize Defaults to the library default of 4MiB if falsy. |
 | lightstep.plain_port | int | `8383` |  |
 | lightstep.project_name | string | `""` | REQUIRED if `lightstep.disable_access_token_checking` is `true` |
 | lightstep.satelliteKey | string | `""` | REQUIRED: your Satellite Key - if not set, `lightstep.collector_satellite_key_secret_name` and `lightstep.collector_satellite_key_secret_key` must be set |

charts/lightstepsatellite/values.yaml

@@ -117,9 +117,9 @@ lightstep:
   secure_port: 9393
   tls_cert_prefix:
   collector_ingestion_tags:
-  # Configure max gRPC receive message size in bytes.
+  # -- Configure max gRPC receive message size in bytes.
   # https://pkg.go.dev/google.golang.org/grpc#MaxRecvMsgSize
-  # Defaults to the library default of 4MiB.
+  # Defaults to the library default of 4MiB if falsy.
   max_msg_size_bytes: 0
 
 # Recommended resources would be 2Gi memory and 2 cpu