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 a "warning" section to HELP.md #1006

Closed
snicoll opened this issue Sep 18, 2019 · 2 comments
Closed

Add a "warning" section to HELP.md #1006

snicoll opened this issue Sep 18, 2019 · 2 comments
Assignees
Milestone

Comments

@snicoll
Copy link
Contributor

snicoll commented Sep 18, 2019

There are a number of customizers that could change the project to tune something or to prevent an incompatible combination. Sometimes there are things the UI doesn't convey we'd like to warn the user about.

Having a dedicated model in HELP.md would be useful as we could be in control of where to actually display that information rather than having a collection of unrelated sections.

@onobc
Copy link
Contributor

onobc commented Oct 17, 2019

@snicoll I would like to take this issue. I am new to contributing to Initializr but am a user (we have a forked customized version) and am excited to get involved.

@snicoll
Copy link
Contributor Author

snicoll commented Oct 17, 2019

Thanks for the offer @bono007 and glad you're using the library in a custom instance. I think the main issue is that we need to discuss the phrasing and the structure of the section as well as its location. I don't want you to waste time on a proposal that we'd heavily refactor so I think we need to come up to an agreement as what it would look like concretely. Unfortunately, we don't have a lot of bandwidth at the moment. I've added a label to make that more explicit.

@snicoll snicoll added the status: pending-design-work Needs design work before any code can be developed label Oct 17, 2019
@snicoll snicoll removed the status: pending-design-work Needs design work before any code can be developed label Dec 27, 2019
@snicoll snicoll self-assigned this Dec 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants