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

Add list of available run & build options to the beginning of corresponding section in readme #52

Open
leonard-huebner opened this issue May 28, 2023 · 0 comments · May be fixed by #53
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@leonard-huebner
Copy link
Contributor

What?

I propose to add a list of available run and build options at the beginning of the How to build and run the ELISA Cluster demo section of the readme.

The items could be listed in order of increasing complexity, eg.

  • fetch & run precompiled image
  • build using docker container
  • manual build (w/ & w/o cache)

For each item, a link to the document detailing the approach could be provided.
For each item, a very short For whom? and For what? description could be added.

Why?

I personally do not read the full build instructions in their entirety before I start executing them, but instead read and execute them step by step. If one approaches the current run & build section in this manner, one will for example learn about the build via docker only after one has basically finished the more laborious manual build. An overview of the different ways to run and build the demo at the beginning could improve the onboarding experience.

@leonard-huebner leonard-huebner self-assigned this May 28, 2023
@leonard-huebner leonard-huebner added the documentation Improvements or additions to documentation label May 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant