Fix documentation typos from #7916

docs/sources/configuration/_index.md

@@ -15,7 +15,7 @@ depending on which mode Loki is launched in.
 
 Configuration examples can be found in the [Configuration Examples](examples/) document.
 
-## Printing Loki Config At Runtime
+## Printing Loki config at runtime
 
 If you pass Loki the flag `-print-config-stderr` or `-log-config-reverse-order`, (or `-print-config-stderr=true`)
 Loki will dump the entire config object it has created from the built-in defaults combined first with
@@ -34,14 +34,14 @@ is especially useful in making sure your config files and flags are being read a
 `-log-config-reverse-order` is the flag we run Loki with in all our environments, the config entries are reversed so
 that the order of configs reads correctly top to bottom when viewed in Grafana's Explore.
 
-## Reload At Runtime
+## Reload at runtime
 
 Promtail can reload its configuration at runtime. If the new configuration
 is not well-formed, the changes will not be applied.
 A configuration reload is triggered by sending a `SIGHUP` to the Promtail process or
 sending a HTTP POST request to the `/reload` endpoint (when the `--server.enable-runtime-reload` flag is enabled).
 
-## Configuration File Reference
+## Configuration file reference
 
 To specify which configuration file to load, pass the `-config.file` flag at the
 command line. The value can be a list of comma separated paths, then the first
@@ -460,7 +460,7 @@ rate_store:
 Configures the `querier`. Only appropriate when running all modules or just the querier.
 
 ```yaml
-# Maximum duration for which the live tailing requests should be served.
+# Maximum duration for which the live tailing requests are served.
 # CLI flag: -querier.tail-max-duration
 [tail_max_duration: <duration> | default = 1h]
 
@@ -990,7 +990,7 @@ ring:
 # CLI flag: -ruler.flush-period
 [flush_period: <duration> | default = 1m]
 
-# Enable the ruler api.
+# Enable the ruler API.
 # CLI flag: -ruler.enable-api
 [enable_api: <boolean> | default = true]
 
@@ -1319,7 +1319,7 @@ wal:
   # CLI flag: -ingester.wal-enabled
   [enabled: <boolean> | default = true]
 
-  # Directory where the WAL data should be stored and/or recovered from.
+  # Directory where the WAL data is stored and/or recovered from.
   # CLI flag: -ingester.wal-dir
   [dir: <string> | default = "wal"]
 

docs/sources/configuration/index.template

@@ -15,7 +15,7 @@ depending on which mode Loki is launched in.
 
 Configuration examples can be found in the [Configuration Examples](examples/) document.
 
-## Printing Loki Config At Runtime
+## Printing Loki config at runtime
 
 If you pass Loki the flag `-print-config-stderr` or `-log-config-reverse-order`, (or `-print-config-stderr=true`)
 Loki will dump the entire config object it has created from the built-in defaults combined first with
@@ -34,14 +34,14 @@ is especially useful in making sure your config files and flags are being read a
 `-log-config-reverse-order` is the flag we run Loki with in all our environments, the config entries are reversed so
 that the order of configs reads correctly top to bottom when viewed in Grafana's Explore.
 
-## Reload At Runtime
+## Reload at runtime
 
 Promtail can reload its configuration at runtime. If the new configuration
 is not well-formed, the changes will not be applied.
 A configuration reload is triggered by sending a `SIGHUP` to the Promtail process or
 sending a HTTP POST request to the `/reload` endpoint (when the `--server.enable-runtime-reload` flag is enabled).
 
-## Configuration File Reference
+## Configuration file reference
 
 To specify which configuration file to load, pass the `-config.file` flag at the
 command line. The value can be a list of comma separated paths, then the first

pkg/ingester/wal.go

@@ -40,7 +40,7 @@ func (cfg *WALConfig) Validate() error {
 
 // RegisterFlags adds the flags required to config this to the given FlagSet
 func (cfg *WALConfig) RegisterFlags(f *flag.FlagSet) {
-	f.StringVar(&cfg.Dir, "ingester.wal-dir", "wal", "Directory where the WAL data should be stored and/or recovered from.")
+	f.StringVar(&cfg.Dir, "ingester.wal-dir", "wal", "Directory where the WAL data is stored and/or recovered from.")
 	f.BoolVar(&cfg.Enabled, "ingester.wal-enabled", true, "Enable writing of ingested data into WAL.")
 	f.DurationVar(&cfg.CheckpointDuration, "ingester.checkpoint-duration", 5*time.Minute, "Interval at which checkpoints should be created.")
 	f.BoolVar(&cfg.FlushOnShutdown, "ingester.flush-on-shutdown", false, "When WAL is enabled, should chunks be flushed to long-term storage on shutdown.")

pkg/querier/querier.go

@@ -60,7 +60,7 @@ type Config struct {
 // RegisterFlags register flags.
 func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
 	cfg.Engine.RegisterFlagsWithPrefix("querier", f)
-	f.DurationVar(&cfg.TailMaxDuration, "querier.tail-max-duration", 1*time.Hour, "Maximum duration for which the live tailing requests should be served.")
+	f.DurationVar(&cfg.TailMaxDuration, "querier.tail-max-duration", 1*time.Hour, "Maximum duration for which the live tailing requests are served.")
 	f.DurationVar(&cfg.ExtraQueryDelay, "querier.extra-query-delay", 0, "Time to wait before sending more than the minimum successful query requests.")
 	f.DurationVar(&cfg.QueryIngestersWithin, "querier.query-ingesters-within", 3*time.Hour, "Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester.")
 	f.IntVar(&cfg.MaxConcurrent, "querier.max-concurrent", 10, "The maximum number of concurrent queries allowed.")

pkg/ruler/base/ruler.go

@@ -172,7 +172,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
 	f.StringVar(&cfg.ShardingStrategy, "ruler.sharding-strategy", util.ShardingStrategyDefault, fmt.Sprintf("The sharding strategy to use. Supported values are: %s.", strings.Join(supportedShardingStrategies, ", ")))
 	f.DurationVar(&cfg.FlushCheckPeriod, "ruler.flush-period", 1*time.Minute, "Period with which to attempt to flush rule groups.")
 	f.StringVar(&cfg.RulePath, "ruler.rule-path", "/rules", "File path to store temporary rule files.")
-	f.BoolVar(&cfg.EnableAPI, "experimental.ruler.enable-api", false, "Enable the ruler api.")
+	f.BoolVar(&cfg.EnableAPI, "experimental.ruler.enable-api", false, "Enable the ruler API.")
 	f.DurationVar(&cfg.OutageTolerance, "ruler.for-outage-tolerance", time.Hour, `Max time to tolerate outage for restoring "for" state of alert.`)
 	f.DurationVar(&cfg.ForGracePeriod, "ruler.for-grace-period", 10*time.Minute, `Minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than the grace period.`)
 	f.DurationVar(&cfg.ResendDelay, "ruler.resend-delay", time.Minute, `Minimum amount of time to wait before resending an alert to Alertmanager.`)

pkg/ruler/config.go

@@ -31,7 +31,7 @@ func (c *Config) RegisterFlags(f *flag.FlagSet) {
 	c.WALCleaner.RegisterFlags(f)
 
 	// TODO(owen-d, 3.0.0): remove deprecated experimental prefix in Cortex if they'll accept it.
-	f.BoolVar(&c.Config.EnableAPI, "ruler.enable-api", true, "Enable the ruler api.")
+	f.BoolVar(&c.Config.EnableAPI, "ruler.enable-api", true, "Enable the ruler API.")
 }
 
 // Validate overrides the embedded cortex variant which expects a cortex limits struct. Instead, copy the relevant bits over.