Browse Source

Move other stuff to reference folder

pull/328/head
Ryan Nowak 7 years ago
parent
commit
3f994be2fd
  1. 4
      docs/README.md
  2. 2
      docs/reference/commandline/tye-init.md
  3. 12
      docs/reference/schema.md
  4. 0
      docs/reference/service_discovery.md
  5. 2
      docs/tutorials/hello-tye/00_run_locally.md
  6. 2
      docs/tutorials/hello-tye/01_deploy.md

4
docs/README.md

@ -22,5 +22,5 @@
| Area | Description | | Area | Description |
|------|-------------| |------|-------------|
|**[Tye Commandline Reference](reference/commandline/README.md)** | Documentation for `tye` commands. |**[Tye Commandline Reference](reference/commandline/README.md)** | Documentation for `tye` commands.
|**[Service Discovery](service_discovery.md)** | Learn more about service discovery in Tye. |**[Service Discovery](reference/service_discovery.md)** | Learn more about service discovery in Tye.
|**[`tye.yaml` Schema](schema.md)** | `tye.yaml` configuration. |**[`tye.yaml` Schema](reference/schema.md)** | `tye.yaml` configuration.

2
docs/reference/commandline/tye-init.md

@ -25,7 +25,7 @@ services:
project: project2/project2.csproj project: project2/project2.csproj
``` ```
See [the tye.yaml schema](../schema.md) to learn more about customizations that can be made to the `tye.yaml` file. See [the tye.yaml schema](/docs/reference/schema.md) to learn more about customizations that can be made to the `tye.yaml` file.
## Arguments ## Arguments

12
docs/schema.md → docs/reference/schema.md

@ -206,7 +206,7 @@ The value of the environment variable.
Bindings represent protocols *exposed* by a service. How bindings are specified can affect both: Bindings represent protocols *exposed* by a service. How bindings are specified can affect both:
- How a project is run. - How a project is run.
- How [service discovery](/docs/service_discovery.md) is performed. - How [service discovery](/docs/reference/service_discovery.md) is performed.
Bindings should either provide: Bindings should either provide:
@ -233,25 +233,25 @@ name: myapplication
The name of the binding. Binding names are optional and should be omitted when a service contains a single binding. If a service provides two or more bindings, then they all must have names. The name of the binding. Binding names are optional and should be omitted when a service contains a single binding. If a service provides two or more bindings, then they all must have names.
Names are part of the [service discovery](/docs/service_discovery.md) protocol. Names are part of the [service discovery](/docs/reference/service_discovery.md) protocol.
#### `connectionString` (string) #### `connectionString` (string)
The connection string of the binding. Connection strings should be used when connecting to the binding requires additional information besides a URL. [Service discovery](/docs/service_discovery.md) treats connection string as a single opaque value and will ignore other properties like `port`. The connection string of the binding. Connection strings should be used when connecting to the binding requires additional information besides a URL. [Service discovery](/docs/reference/service_discovery.md) treats connection string as a single opaque value and will ignore other properties like `port`.
As an example, connecting to a hosted redis using authentication requires a URL as well as username and password. Using a connection string is typical for databases or anything that requires authentication. As an example, connecting to a hosted redis using authentication requires a URL as well as username and password. Using a connection string is typical for databases or anything that requires authentication.
#### `protocol` (string) #### `protocol` (string)
Specifies the protocol used by the binding. The protocol is used in [service discovery](/docs/service_discovery.md) to construct a URL. It's safe to omit the `protocol` when it's not needed to connect to the service. As an example, connecting to redis without authentication only requires a hostname and port. Specifies the protocol used by the binding. The protocol is used in [service discovery](/docs/reference/service_discovery.md) to construct a URL. It's safe to omit the `protocol` when it's not needed to connect to the service. As an example, connecting to redis without authentication only requires a hostname and port.
#### `host` (string) #### `host` (string)
Specifies the hostname used by the binding. The protocol is used in [service discovery](/docs/service_discovery.md) to construct a URL. It's safe to omit the `host` when localhost should be used for local development. Specifies the hostname used by the binding. The protocol is used in [service discovery](/docs/reference/service_discovery.md) to construct a URL. It's safe to omit the `host` when localhost should be used for local development.
#### `port` (string) #### `port` (string)
Specifies the port used by the binding. The port is used in [service discovery](/docs/service_discovery.md) to construct a URL. Specifies the port used by the binding. The port is used in [service discovery](/docs/reference/service_discovery.md) to construct a URL.
#### `internalPort` (string deprecated, use containerPort instead) #### `internalPort` (string deprecated, use containerPort instead)

0
docs/service_discovery.md → docs/reference/service_discovery.md

2
docs/tutorials/hello-tye/00_run_locally.md

@ -63,7 +63,7 @@ This tutorial will demonstrate how to use [`tye run`](/docs/reference/commandlin
## Getting the frontend to communicate with the backend ## Getting the frontend to communicate with the backend
Now that we have two applications running, let's make them communicate. By default, `tye` enables service discovery by injecting environment variables with a specific naming convention. For more information on, see [service discovery](/docs/service_discovery.md). Now that we have two applications running, let's make them communicate. By default, `tye` enables service discovery by injecting environment variables with a specific naming convention. For more information on, see [service discovery](/docs/reference/service_discovery.md).
1. Add a NuGet.config to add the `dotnet-core` package source. 1. Add a NuGet.config to add the `dotnet-core` package source.

2
docs/tutorials/hello-tye/01_deploy.md

@ -115,7 +115,7 @@ Tye has a optional configuration file (`tye.yaml`) to allow customizing settings
`tye.yaml` lists all of the application's services under the `services` node. This is the place for per-service configuration. `tye.yaml` lists all of the application's services under the `services` node. This is the place for per-service configuration.
See [schema](schema.md) for more details about `tye.yaml`. See [schema](/docs/reference/schema.md) for more details about `tye.yaml`.
> :bulb: We provide a json-schema for `tye.yaml` and some editors support json-schema for completion and validation of yaml files. See [json-schema](/src/schema/README.md) for instructions. > :bulb: We provide a json-schema for `tye.yaml` and some editors support json-schema for completion and validation of yaml files. See [json-schema](/src/schema/README.md) for instructions.

Loading…
Cancel
Save