Remove Swarm references from Japanese translation

alexellis commented 3 years ago

Expected Behaviour

Remove remaining Docker Swarm references

Current Behaviour

Swarm isn't supported by OpenFaaS, but it is mentioned here in some files.

Possible Solution

Work through each file and update it, also remove wording such as "If on Kubernetes..."

The workshop won't have support for faasd, which has a separate eBook and guide.

kadern0 commented 3 years ago

Japanese translations would probably have to be updated too.

alexellis commented 3 years ago

I'm not sure if we are in contact with any Japanese speakers. Could you look at the git commit history and ping a couple of people here?

kadern0 commented 3 years ago

Hi @kenfdev and @toshi0607, I've removed all the Docker Swarm references from the labs, could you do the same for the Japanese translation?

alexellis commented 2 years ago

/add label: help wanted, good first issue

alexellis commented 2 years ago

/set title: Remove Swarm references from Japanese translation

inductor commented 2 years ago

@alexellis Hi, not sure the progress here but does the issue scope only refer to removal of Docker Swarm related lines which https://github.com/openfaas/workshop/pull/193 covers? If so I wouldn't mind doing it but not sure if there's anything else that has to be updated.

alexellis commented 2 years ago

It's the equivalent changes, but in the Japanese README file. Does that make sense?

https://github.com/openfaas/workshop/tree/master/translations/ja

inductor commented 2 years ago

Is only README fine? or do you want to change all of the labs?

alexellis commented 2 years ago

Anywhere you see the word "Swarm", remove those lines. If the surrounding lines need updating we will need that too, for instance:

"Pick one of the two options of Swarm and Kubernetes" <- that sentence needs reformatting.

But if it says: "Now run kubectl get pods. On Swarm run..." You can just remove the Swarm part.

So yes, check each of the files.

inductor commented 2 years ago

@alexellis I'm having a look at differences but the Japanese translation looks very outdated.

For example the setup a single-node cluster section in lab1 in English has the following diff.

- The labs use Kubernetes, and still have some references to Docker Swarm. Please ignore those references as Swarm is no longer supported by the OpenFaaS community. Some of the workshop labs will work for faasd, but you may need to alter the commands and we do not provide support for the workshop when taken with faasd.
+ The labs use Kubernetes, Swarm is no longer supported by the OpenFaaS community. Some of the workshop labs will work for faasd, but you may need to alter the commands and we do not provide support for the workshop when taken with faasd.

https://github.com/openfaas/workshop/pull/193/files#diff-097f79b5e813d46f4c17d6e5a2635bb4c068854e07cbfb5e63dd037242e3d8aeL93

But Japanese doesn't have this whole sentence and it includes a dedicated section for Docker Swarm that implies something like "You can use either Kubernetes and Docker Swarm but in a workshop you probably prefer to use Swarm rather than Kubernetes because it's easier to setup.". So I would say reconstruction would be required.

https://github.com/openfaas/workshop/blame/master/translations/ja/lab1.md#L41

I would not mind just removing Swarm related lines but it won't be up to date and updating the whole translation should be done in another PR.

Any opinions?

alexellis commented 2 years ago

For now, I think it would be helpful to prevent new users from assuming Swarm is valid and trying that out.

Synchronising the translation is an optional technical debt item in my eyes.

openfaas / workshop