Browse Source

Create reference folder and move commandline

pull/328/head
Ryan Nowak 6 years ago
parent
commit
3a5a991f33
  1. 7
      docs/README.md
  2. 2
      docs/frontend_backend_deploy.md
  3. 6
      docs/frontend_backend_run.md
  4. 8
      docs/reference/commandline/README.md
  5. 0
      docs/reference/commandline/tye-deploy.md
  6. 0
      docs/reference/commandline/tye-init.md
  7. 0
      docs/reference/commandline/tye-run.md
  8. 0
      docs/reference/commandline/tye.md

7
docs/README.md

@ -7,7 +7,7 @@
|**[Getting Started](getting_started.md)** | Set up your development environment. |**[Getting Started](getting_started.md)** | Set up your development environment.
|**[Frontend Backend Run Example](frontend_backend_run.md)** | Learn how to run an application locally with tye. |**[Frontend Backend Run Example](frontend_backend_run.md)** | Learn how to run an application locally with tye.
|**[Frontend Backend Deploy Example](frontend_backend_deploy.md)** | Learn how to deploy an application with tye. |**[Frontend Backend Deploy Example](frontend_backend_deploy.md)** | Learn how to deploy an application with tye.
| **[Adding Redis](redis.md)** | Learn how to add redis for development and deployed to a development cluster. |**[Adding Redis](redis.md)** | Learn how to add redis for development and deployed to a development cluster.
## Recipes ## Recipes
@ -17,9 +17,10 @@
|**[Using Dapr with Tye](recipes/dapr.md)** | Using Tye for local development and deployment with a [Dapr](https://dapr.io) application. |**[Using Dapr with Tye](recipes/dapr.md)** | Using Tye for local development and deployment with a [Dapr](https://dapr.io) application.
## Further documentation ## Reference documentation
| Area | Description | | Area | Description |
|------|-------------| |------|-------------|
| **[Service Discovery](service_discovery.md)** | Learn more about service discovery in tye. |**[Tye Commandline Reference](reference/commandline/README.md)** | Documentation for `tye` commands.
|**[Service Discovery](service_discovery.md)** | Learn more about service discovery in tye.
|**[Tye Schema](schema.md)** | `tye.yaml` configuration. |**[Tye Schema](schema.md)** | `tye.yaml` configuration.

2
docs/frontend_backend_deploy.md

@ -2,7 +2,7 @@
This tutorial assumes that you have completed the [Frontend Backend Run Sample](frontend_backend_run.md) This tutorial assumes that you have completed the [Frontend Backend Run Sample](frontend_backend_run.md)
> :bulb: `tye` will use your current credentials for pushing Docker images and accessing kubernetes clusters. If you have configured kubectl with a context already, that's what [`tye deploy`](commandline/tye-deploy.md) is going to use! > :bulb: `tye` will use your current credentials for pushing Docker images and accessing kubernetes clusters. If you have configured kubectl with a context already, that's what [`tye deploy`](/docs/reference/commandline/tye-deploy.md) is going to use!
Before we deploy, make sure you have the following ready... Before we deploy, make sure you have the following ready...

6
docs/frontend_backend_run.md

@ -1,6 +1,6 @@
# Frontend Backend sample with tye run # Frontend Backend sample with tye run
This tutorial will demonstrate how to use [`tye run`](commandline/tye-run.md) to run a multi-project application. If you haven't so already, follow the [Getting Started Instructions](getting_started.md) to install tye. This tutorial will demonstrate how to use [`tye run`](/docs/reference/commandline/tye-run.md) to run a multi-project application. If you haven't so already, follow the [Getting Started Instructions](getting_started.md) to install tye.
## Running a single application with tye run ## Running a single application with tye run
@ -214,10 +214,10 @@ Now that we have two applications running, let's make them communicate. By defau
</table> </table>
``` ```
9. Run the project with [`tye run`](commandline/tye-run.md) and the `frontend` service should be able to successfully call the `backend` service! 9. Run the project with [`tye run`](/docs/reference/commandline/tye-run.md) and the `frontend` service should be able to successfully call the `backend` service!
When you visit the `frontend` service you should see a table of weather data. This data was produced randomly in the `backend` service. The fact that you're seeing it in a web UI in the `frontend` means that the services are able to communicate. When you visit the `frontend` service you should see a table of weather data. This data was produced randomly in the `backend` service. The fact that you're seeing it in a web UI in the `frontend` means that the services are able to communicate.
## Next Steps ## Next Steps
Now that you are able to run a multi-project application with [`tye run`](commandline/tye-run.md), move on to the [Frontend Backend Deploy Sample](frontend_backend_deploy.md) to learn how to deploy this application to Kubernetes. Now that you are able to run a multi-project application with [`tye run`](/docs/reference/commandline/tye-run.md), move on to the [Frontend Backend Deploy Sample](frontend_backend_deploy.md) to learn how to deploy this application to Kubernetes.

8
docs/reference/commandline/README.md

@ -0,0 +1,8 @@
# 📖 Tye commandline documentation
| Topic | Description |
|-------|-------------|
|**[tye init](tye-init.md)** | Create a `tye.yaml`.
|**[tye run](tye-run.md)** | Run an application locally.
|**[tye deploy](tye-deploy.md)** | Deploy an application.
|**[tye](tye.md)** | Base command.

0
docs/commandline/tye-deploy.md → docs/reference/commandline/tye-deploy.md

0
docs/commandline/tye-init.md → docs/reference/commandline/tye-init.md

0
docs/commandline/tye-run.md → docs/reference/commandline/tye-run.md

0
docs/commandline/tye.md → docs/reference/commandline/tye.md

Loading…
Cancel
Save