eiffel-community / eiffel-easy2use

A sandbox to be used to try out the Eiffel protocol and related services
Apache License 2.0
10 stars 19 forks source link

Missing tutorial for Eiffel bundle #45

Open e-pettersson-ericsson opened 4 years ago

e-pettersson-ericsson commented 4 years ago

Description

The Cx and GitLab bundles each have a tutorial of sorts, but the Eiffel bundle does not. Since GitLab and Argo/Jenkins are well documented elsewhere it's enough for users to get going with the tutorials we have.

But if users are trying easy2use with the purpose of learning Eiffel and the available services it is a MUST to have such a walk through guide.

How to find the URL to Rabbit MQ? How do I login to Rabbit MQ? How do I publish messages to Rabbit MQ? Which of the included components are acting as listeners to Eiffel events? etc ...

Motivation

A good walk through guide can help first time users to quickly familiarize themselves with the concept of the bundle and to test out their services in combination with the bundle deployed services.

Exemplification

It would be nice if it aligns with the other tutorials we have. At least some sort of explanation (with URL and username/password needed) for each of the deployed service in the bundle. Perhaps include navigation tips if there is any GUI etc ...

Benefits

A good starting point for first time users of Eiffel who want to quickly learn how to use services.

Possible Drawbacks

Keep in mind to keep the information maintainable, so it doesn't become outdated in the next few releases. Perhaps keep a general overview of each component in this tutorial - and then redirect further reading in the documentation for that specific service?

m-linner-ericsson commented 2 years ago

Example of a "tutorial":