jhipster / generator-jhipster

JHipster is a development platform to quickly generate, develop, & deploy modern web applications & microservice architectures.
https://www.jhipster.tech
Apache License 2.0
21.54k stars 4.02k forks source link

Feature Request: Add quick inline help in setup process #19762

Closed spotlesscoder closed 9 months ago

spotlesscoder commented 2 years ago
Overview of the feature request

I want to know what certain options in the project setup wizard are meant to be used for.

Motivation for or Use Case

Updated to Jhipster 7.9.3 today and generated a new project. Recognized there is a new step "Use microfrontends (y/n)?" Though in this case it is quite obvious what this option is meant to be used for, a quick 2-3 sentence description with some keywords would give users a better idea of what to expect when enabling that option.

Currently, there are two available choices for most options in project generation: "yes (y)" or "no (n)". I would love to have add a third option "help (h)" added. When pressing h, the short description should appear. When then pressing ESC or q, the user should be returned to the selection (y/n)

Related issues or PR
emilpaw commented 2 years ago

I don't think having the documentation in two places is a good idea. Instead, we should direct the effort into improving the documentation on the website.

gmarziou commented 2 years ago

An alternative would be to print a link to online documentation at the end of the question, most terminals are able to make them clickable.

spotlesscoder commented 2 years ago

Yes, that might also work :)

github-actions[bot] commented 10 months ago

This issue is stale because it has been open for too long without any activity. Due to the moving nature of jhipster generated application, bugs can become invalid. If this issue still applies please comment otherwise it will be closed in 7 days