Skip to content

Commit

Permalink
fixup! WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ezzatron committed Mar 16, 2024
1 parent 7cc1626 commit 88e5876
Show file tree
Hide file tree
Showing 42 changed files with 71 additions and 71 deletions.
24 changes: 12 additions & 12 deletions ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The `run.ts` app uses **declarative environment variables** powered by

## `CDN_URL`

_**CDN to use when serving static assets**_
_CDN to use when serving static assets_

The `CDN_URL` variable is a **required** variable
that takes **URL** values.
Expand All @@ -35,7 +35,7 @@ export CDN_URL=https://host.example.org/path/to/resource # URL (absolute)

## `DEBUG`

_**Enable or disable debugging features**_
_Enable or disable debugging features_

The `DEBUG` variable is an **optional** variable
that takes `true` or `false`.
Expand All @@ -58,7 +58,7 @@ export DEBUG=false # false

## `EARTH_ATOM_COUNT`

_**Number of atoms on earth**_
_Number of atoms on earth_

The `EARTH_ATOM_COUNT` variable is an **optional** variable
that takes **big integer** values.
Expand Down Expand Up @@ -87,7 +87,7 @@ export EARTH_ATOM_COUNT=0b11110001001000000 # binary

## `GRPC_TIMEOUT`

_**GRPC request timeout**_
_GRPC request timeout_

The `GRPC_TIMEOUT` variable is an **optional** variable
that takes **ISO 8601 duration** values.
Expand All @@ -104,7 +104,7 @@ export GRPC_TIMEOUT=P1M15DT12H # ISO 8601 duration

## `LOG_LEVEL`

_**The minimum log level to record**_
_The minimum log level to record_

The `LOG_LEVEL` variable is an **optional** variable
that takes `debug`, `info`, `warn`, `error`, or `fatal`.
Expand Down Expand Up @@ -139,7 +139,7 @@ export LOG_LEVEL=fatal # the application cannot proceed

## `PORT`

_**Listen port for the HTTP server**_
_Listen port for the HTTP server_

The `PORT` variable is an **optional** variable
that takes **port number** values.
Expand All @@ -158,7 +158,7 @@ export PORT=12345 # a port number

## `READ_DSN`

_**Database connection string for read-models**_
_Database connection string for read-models_

The `READ_DSN` variable is a **required** variable
that takes **string** values.
Expand All @@ -175,7 +175,7 @@ export READ_DSN='alabaster parakeet' # some values may need escaping

## `REDIS_PRIMARY_SERVICE_HOST`

_**Kubernetes `redis-primary` service host**_
_Kubernetes `redis-primary` service host_

The `REDIS_PRIMARY_SERVICE_HOST` variable is a **required** variable
that takes **hostname** values.
Expand All @@ -192,7 +192,7 @@ export REDIS_PRIMARY_SERVICE_HOST=10.0.0.11 # an IP address

## `REDIS_PRIMARY_SERVICE_PORT`

_**Kubernetes `redis-primary` service port**_
_Kubernetes `redis-primary` service port_

The `REDIS_PRIMARY_SERVICE_PORT` variable is a **required** variable
that takes **port number** values.
Expand All @@ -205,7 +205,7 @@ export REDIS_PRIMARY_SERVICE_PORT=12345 # a port number

## `SAMPLE_RATIO`

_**Ratio of requests to sample**_
_Ratio of requests to sample_

The `SAMPLE_RATIO` variable is an **optional** variable
that takes **number** values.
Expand Down Expand Up @@ -242,7 +242,7 @@ export SAMPLE_RATIO=0b11110001001000000 # binary

## `SESSION_KEY`

_**Session token signing key**_
_Session token signing key_

The `SESSION_KEY` variable is a **required** variable
that takes **base64** values.
Expand All @@ -255,7 +255,7 @@ export SESSION_KEY=Y29ucXVpc3RhZG9y # base64 encoded string

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is a **required** variable
that takes **integer** values.
Expand Down
2 changes: 1 addition & 1 deletion src/specification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function variable(variable: Variable<unknown>): string {

return `## ${inlineCode(name)}
${italic(strong(uppercaseFirst(description)))}
${italic(uppercaseFirst(description))}
${variable.spec.schema.accept(createSchemaRenderer(variable))}
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is an **optional** variable
that takes **big integer** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is an **optional** variable
that takes **big integer** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is a **required** variable
that takes **big integer** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/binary/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `SESSION_KEY`

_**Session token signing key**_
_Session token signing key_

The `SESSION_KEY` variable is an **optional** variable
that takes **base64** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/binary/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `SESSION_KEY`

_**Session token signing key**_
_Session token signing key_

The `SESSION_KEY` variable is an **optional** variable
that takes **base64** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/binary/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `SESSION_KEY`

_**Session token signing key**_
_Session token signing key_

The `SESSION_KEY` variable is a **required** variable
that takes **base64** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/custom-literals.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `DEBUG`

_**Enable or disable debugging features**_
_Enable or disable debugging features_

The `DEBUG` variable is an **optional** variable
that takes `y`, `yes`, `n`, or `no`.
Expand Down
4 changes: 2 additions & 2 deletions test/fixture/specification/boolean/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `DEBUG`

_**Enable or disable debugging features**_
_Enable or disable debugging features_

The `DEBUG` variable is an **optional** variable
that takes `true` or `false`.
Expand All @@ -35,7 +35,7 @@ export DEBUG=false # false

## `PRODUCTION`

_**Enable or disable production mode**_
_Enable or disable production mode_

The `PRODUCTION` variable is an **optional** variable
that takes `true` or `false`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `DEBUG`

_**Enable or disable debugging features**_
_Enable or disable debugging features_

The `DEBUG` variable is an **optional** variable
that takes `true` or `false`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `DEBUG`

_**Enable or disable debugging features**_
_Enable or disable debugging features_

The `DEBUG` variable is a **required** variable
that takes `true` or `false`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `GRPC_TIMEOUT`

_**GRPC request timeout**_
_GRPC request timeout_

The `GRPC_TIMEOUT` variable is an **optional** variable
that takes **ISO 8601 duration** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `GRPC_TIMEOUT`

_**GRPC request timeout**_
_GRPC request timeout_

The `GRPC_TIMEOUT` variable is an **optional** variable
that takes **ISO 8601 duration** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `GRPC_TIMEOUT`

_**GRPC request timeout**_
_GRPC request timeout_

The `GRPC_TIMEOUT` variable is a **required** variable
that takes **ISO 8601 duration** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `LOG_LEVEL`

_**The minimum log level to record**_
_The minimum log level to record_

The `LOG_LEVEL` variable is an **optional** variable
that takes `debug`, `info`, `warn`, `error`, or `fatal`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `LOG_LEVEL`

_**The minimum log level to record**_
_The minimum log level to record_

The `LOG_LEVEL` variable is an **optional** variable
that takes `debug`, `info`, `warn`, `error`, or `fatal`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `LOG_LEVEL`

_**The minimum log level to record**_
_The minimum log level to record_

The `LOG_LEVEL` variable is a **required** variable
that takes `debug`, `info`, `warn`, `error`, or `fatal`.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/integer/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is an **optional** variable
that takes **integer** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/integer/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is an **optional** variable
that takes **integer** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/integer/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `WEIGHT`

_**Weighting for this node**_
_Weighting for this node_

The `WEIGHT` variable is a **required** variable
that takes **integer** values.
Expand Down
4 changes: 2 additions & 2 deletions test/fixture/specification/kubernetes-address/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `REDIS_PRIMARY_SERVICE_HOST`

_**Kubernetes `redis-primary` service host**_
_Kubernetes `redis-primary` service host_

The `REDIS_PRIMARY_SERVICE_HOST` variable is an **optional** variable
that takes **hostname** values.
Expand All @@ -35,7 +35,7 @@ export REDIS_PRIMARY_SERVICE_HOST=10.0.0.11 # an IP address

## `REDIS_PRIMARY_SERVICE_PORT`

_**Kubernetes `redis-primary` service port**_
_Kubernetes `redis-primary` service port_

The `REDIS_PRIMARY_SERVICE_PORT` variable is an **optional** variable
that takes **port number** values.
Expand Down
6 changes: 3 additions & 3 deletions test/fixture/specification/kubernetes-address/named-ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `REDIS_PRIMARY_SERVICE_HOST`

_**Kubernetes `redis-primary` service host**_
_Kubernetes `redis-primary` service host_

The `REDIS_PRIMARY_SERVICE_HOST` variable is a **required** variable
that takes **hostname** values.
Expand All @@ -30,7 +30,7 @@ export REDIS_PRIMARY_SERVICE_HOST=10.0.0.11 # an IP address

## `REDIS_PRIMARY_SERVICE_PORT_DB`

_**Kubernetes `redis-primary` service `db` port**_
_Kubernetes `redis-primary` service `db` port_

The `REDIS_PRIMARY_SERVICE_PORT_DB` variable is a **required** variable
that takes **port number** values.
Expand All @@ -43,7 +43,7 @@ export REDIS_PRIMARY_SERVICE_PORT_DB=12345 # a port number

## `REDIS_PRIMARY_SERVICE_PORT_OBSERVABILITY`

_**Kubernetes `redis-primary` service `observability` port**_
_Kubernetes `redis-primary` service `observability` port_

The `REDIS_PRIMARY_SERVICE_PORT_OBSERVABILITY` variable is a **required** variable
that takes **port number** values.
Expand Down
4 changes: 2 additions & 2 deletions test/fixture/specification/kubernetes-address/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `REDIS_PRIMARY_SERVICE_HOST`

_**Kubernetes `redis-primary` service host**_
_Kubernetes `redis-primary` service host_

The `REDIS_PRIMARY_SERVICE_HOST` variable is an **optional** variable
that takes **hostname** values.
Expand All @@ -29,7 +29,7 @@ export REDIS_PRIMARY_SERVICE_HOST=10.0.0.11 # an IP address

## `REDIS_PRIMARY_SERVICE_PORT`

_**Kubernetes `redis-primary` service port**_
_Kubernetes `redis-primary` service port_

The `REDIS_PRIMARY_SERVICE_PORT` variable is an **optional** variable
that takes **port number** values.
Expand Down
4 changes: 2 additions & 2 deletions test/fixture/specification/kubernetes-address/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `REDIS_PRIMARY_SERVICE_HOST`

_**Kubernetes `redis-primary` service host**_
_Kubernetes `redis-primary` service host_

The `REDIS_PRIMARY_SERVICE_HOST` variable is a **required** variable
that takes **hostname** values.
Expand All @@ -29,7 +29,7 @@ export REDIS_PRIMARY_SERVICE_HOST=10.0.0.11 # an IP address

## `REDIS_PRIMARY_SERVICE_PORT`

_**Kubernetes `redis-primary` service port**_
_Kubernetes `redis-primary` service port_

The `REDIS_PRIMARY_SERVICE_PORT` variable is a **required** variable
that takes **port number** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/network-port-number/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `PORT`

_**Listen port for the HTTP server**_
_Listen port for the HTTP server_

The `PORT` variable is an **optional** variable
that takes **port number** values.
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/network-port-number/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `<app>` app uses **declarative environment variables** powered by

## `PORT`

_**Listen port for the HTTP server**_
_Listen port for the HTTP server_

The `PORT` variable is an **optional** variable
that takes **port number** values.
Expand Down
Loading

0 comments on commit 88e5876

Please sign in to comment.