Project-MTee / file-translation-worker

MIT License
0 stars 0 forks source link

Install instructions are OS specific #1

Open eduardosanchezg opened 2 years ago

eduardosanchezg commented 2 years ago

Install instructions include commands that are Windows specific. It would be good to include Unix instructions as well.

valterss commented 2 years ago

The Linux Kubernetes deployment of all built components (in a form of docker images) are described in platform's deployment description https://github.com/Project-MTee/mtee-platform/wiki. There are Kubernetes configuration files to deploy. However, the infrastructure and know-how on the deployment of Kubernetes itself is a prerequisite that must be provide by infrastructure provider and is not a deliverable of the project.

Individual components of the project can be run on virtually any platform and the development process and building can be carried out on various platforms.

Describing the development process is more challenging because of differences how individual developers used to work. Different tool, testing and debugging, even different platforms, and approach - setup individual small dev environment, or using complete dev/test environment to connect other services. We have not implemented platform or tool specific requirement for developers, so each may choose from his experience. Some components indeed include development instructions include Windows specifics as the developer has been used them. Like choco install kubernetes-cli which is Kubernetes CLI setup on Windows, on Linux choco may need to replace just by apt-get depending on the flavor of Linux, but the purpose is to show the prerequisites so that developer can decide how to ensure them. If needed we can elaborate description for better understanding about specific required prerequisites or describing the point of certain command examples.