Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing tutorial for Eiffel bundle #45

Open
e-pettersson-ericsson opened this issue Mar 3, 2020 · 1 comment
Open

Missing tutorial for Eiffel bundle #45

e-pettersson-ericsson opened this issue Mar 3, 2020 · 1 comment
Labels
documentation Improvements or additions to the documentation.

Comments

@e-pettersson-ericsson
Copy link
Member

e-pettersson-ericsson commented Mar 3, 2020

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 m-linner-ericsson added the documentation Improvements or additions to the documentation. label Jan 26, 2022
@m-linner-ericsson
Copy link
Member

m-linner-ericsson commented Feb 23, 2022

Example of a "tutorial":

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation.
Projects
None yet
Development

No branches or pull requests

2 participants