From 3a54fb873021765e11738898ce265cfd08f8a645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20Tom=C3=A0s?= Date: Fri, 11 Aug 2017 10:03:44 +0200 Subject: [PATCH] Doc index created --- README.ENV.md => readme/README.ENV.md | 0 readme/readme.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+) rename README.ENV.md => readme/README.ENV.md (100%) create mode 100644 readme/readme.md diff --git a/README.ENV.md b/readme/README.ENV.md similarity index 100% rename from README.ENV.md rename to readme/README.ENV.md diff --git a/readme/readme.md b/readme/readme.md new file mode 100644 index 000000000..f2ea7c6cb --- /dev/null +++ b/readme/readme.md @@ -0,0 +1,18 @@ +# Documentation index + +This file contains links to the documentation of the project. + +* **Wiki**: The wiki contains detailed step-by-step information about how to set up the project. Read it at: [https://github.com/dotnet-architecture/eShopOnContainers/wiki](https://github.com/dotnet-architecture/eShopOnContainers/wiki) + +## Documentation included in files + +* [Branch Guide](../branch-guide.md): List of branches used and their purpose. +* [vsts-docs folder](.,/vsts-docs/readme.md): Information about how to setup a CI/CD procedure using VSTS +* [Kubernetes](,./k8s/readme.md): Information about how to deploy eShopOnContainers in a kubernetes cluster, and how to setup a CI/CD for k8s using VSTS +* [deploy](../deploy/readme.md): Information about how deploy Azure resources using the Azure CLI 2.0. +* [.env file](./README.ENV.md): What is the `.env` file and how to use it to configure eShopOnContainers to use external resources (like Azure) + +## Docs folder + +The `/docs` folder contains the pdfs versions of the books +