Skip to content

Commit

Permalink
Update Configuration.md [ci skip] (#4959)
Browse files Browse the repository at this point in the history
* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* fix: remove typo

* doc: suggest link update

* doc: align docs with doc-templates folder according to PR suggestion

* doc: align docs with doc-templates folder according to PR suggestion
  • Loading branch information
dancesWithCycles authored Mar 14, 2023
1 parent 698e151 commit 922df37
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions doc-templates/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ documentation below we will refer to the following types:

## System environment and project information substitution

OTP support injecting system environment variables and project information parameters into the
OTP supports injecting system environment variables and project information parameters into the
configuration. A pattern like `${VAR_NAME}` in a configuration file is substituted with an
environment variable with name `VAR_NAME`. The substitution is done BEFORE the JSON is parsed, so
both json keys and values is subject to substitution. This is useful if you want OTPs version number
both json keys and values are subject to substitution. This is useful if you want OTPs version number
to be part of the _graph-file-name_, or you want to inject credentials in a cloud based deployment.

```JSON
Expand Down Expand Up @@ -113,15 +113,15 @@ in your build-pipeline, at deployment time or use system environment variable su

## OTP Serialization version id and _Graph.obj_ file header

OTP has a _OTP Serialization Version Id_ maintained in the pom.xml_ file. OTP store the id in the
serialized _Graph.obj_ file header, allowing OTP the check for compatibility issues when loading the
OTP has a _OTP Serialization Version Id_ maintained in the pom.xml_ file. OTP stores the id in the
serialized _Graph.obj_ file header, allowing OTP to check for compatibility issues when loading the
graph. The header info is available to configuration substitution:

- `${graph.file.header}` Will expand to: `OpenTripPlannerGraph;0000007;`
- `${otp.serialization.version.id}` Will expand to: `7`

The intended usage is to be able to have a graph build pipeline which "knows" which graph that
matches OTP planner instances. For example, you may build new graphs for every OTP serialization
The intended usage is to be able to have a graph build pipeline that "knows" the matching graph and
OTP planner instance. For example, you may build new graphs for every OTP serialization
version id in use by the planning OTP instances you have deployed and plan to deploy. This way you
can roll forward and backward new OTP instances without worrying about building new graphs.

Expand Down
2 changes: 1 addition & 1 deletion doc-templates/UpdaterConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ feed does not account for unexpected service changes or traffic disruptions that
day. Thus, this kind of data is also referred to as 'static' data or 'theoretical' arrival and
departure times.

The [GTFS-RT spec](https://developers.google.com/transit/gtfs-realtime/) complements GTFS with three
[GTFS-Realtime](https://gtfs.org/realtime/) complements GTFS with three
additional kinds of feeds. In contrast to the base GTFS schedule feed, they provide *real-time*
updates (*'dynamic'* data) and are updated from minute to minute.

Expand Down
12 changes: 6 additions & 6 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,10 @@ documentation below we will refer to the following types:

## System environment and project information substitution

OTP support injecting system environment variables and project information parameters into the
OTP supports injecting system environment variables and project information parameters into the
configuration. A pattern like `${VAR_NAME}` in a configuration file is substituted with an
environment variable with name `VAR_NAME`. The substitution is done BEFORE the JSON is parsed, so
both json keys and values is subject to substitution. This is useful if you want OTPs version number
both json keys and values are subject to substitution. This is useful if you want OTPs version number
to be part of the _graph-file-name_, or you want to inject credentials in a cloud based deployment.

```JSON
Expand Down Expand Up @@ -139,15 +139,15 @@ in your build-pipeline, at deployment time or use system environment variable su

## OTP Serialization version id and _Graph.obj_ file header

OTP has a _OTP Serialization Version Id_ maintained in the pom.xml_ file. OTP store the id in the
serialized _Graph.obj_ file header, allowing OTP the check for compatibility issues when loading the
OTP has a _OTP Serialization Version Id_ maintained in the pom.xml_ file. OTP stores the id in the
serialized _Graph.obj_ file header, allowing OTP to check for compatibility issues when loading the
graph. The header info is available to configuration substitution:

- `${graph.file.header}` Will expand to: `OpenTripPlannerGraph;0000007;`
- `${otp.serialization.version.id}` Will expand to: `7`

The intended usage is to be able to have a graph build pipeline which "knows" which graph that
matches OTP planner instances. For example, you may build new graphs for every OTP serialization
The intended usage is to be able to have a graph build pipeline that "knows" the matching graph and
OTP planner instance. For example, you may build new graphs for every OTP serialization
version id in use by the planning OTP instances you have deployed and plan to deploy. This way you
can roll forward and backward new OTP instances without worrying about building new graphs.

Expand Down
2 changes: 1 addition & 1 deletion docs/UpdaterConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ feed does not account for unexpected service changes or traffic disruptions that
day. Thus, this kind of data is also referred to as 'static' data or 'theoretical' arrival and
departure times.

The [GTFS-RT spec](https://developers.google.com/transit/gtfs-realtime/) complements GTFS with three
[GTFS-Realtime](https://gtfs.org/realtime/) complements GTFS with three
additional kinds of feeds. In contrast to the base GTFS schedule feed, they provide *real-time*
updates (*'dynamic'* data) and are updated from minute to minute.

Expand Down

0 comments on commit 922df37

Please sign in to comment.