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

EAP feedback from Stephan Diehl #1698

Closed
macjuan opened this issue May 30, 2017 · 3 comments
Closed

EAP feedback from Stephan Diehl #1698

macjuan opened this issue May 30, 2017 · 3 comments
Assignees
Labels
Milestone

Comments

@macjuan
Copy link
Contributor

macjuan commented May 30, 2017

From @OSSD

"is there a getting started documentation, to understand the development?

  • why i need a html file
  • what can be generated

my first impression is: i see a lot of static strings, the reference between code and html file. the main reason i use vadim framework is to be able to refactor anything without the risk of runtime errors. we used primefaces in the past and the main problem was, that you reference methods in html files that are not in sync with your java file. when you refactor a method, you will not get an compilation error.

when you need strings in html to reference to variables or methods in java, you will not be type safe. when you ask me, this was the main reason for using java for web development and not php, ruby or something other fancy

my questions for the getting started is: how to work without html files or how to generate them or other way to avoid a runtime error."

@mvysny
Copy link
Member

mvysny commented May 30, 2017

It is possible to use Flow without any html files, but then one is basically stuck with creating the page div-by-div; kinda server-side GWT. Anyway, it is possible: https://gitlab.vaadin.com/mavi/karibu-dsl-flow/blob/master/example-flow/src/main/kotlin/com/github/vok/karibudsl/flowexample/Servlet.kt

@Legioth
Copy link
Member

Legioth commented May 30, 2017

We definitely need to work on the documentation, and especially two things highlighted here:

  • How to get started
  • Clarifying the relationship between elements, components and templates and some kind of guide about which to use in what situation.

@pleku pleku added the backlog label Aug 1, 2017
@pleku pleku self-assigned this Sep 25, 2017
@pleku pleku added in progress and removed backlog labels Sep 25, 2017
pleku added a commit that referenced this issue Sep 28, 2017
pleku added a commit that referenced this issue Sep 28, 2017
@pleku pleku removed the in progress label Oct 1, 2017
pleku added a commit that referenced this issue Dec 1, 2017
pleku added a commit that referenced this issue Jan 11, 2018
pleku added a commit that referenced this issue Jan 11, 2018
pleku added a commit that referenced this issue Jan 12, 2018
Fixes #1698

Moves all files around to make sure content is aligned into preferable reading order.
Also adds a very shallow introduction / architecture page.
@pleku
Copy link
Contributor

pleku commented Jan 12, 2018

#3305 changes the structure of the documentation from almost random to a recommended reading order. The building hello world and getting started are in the beginning.

It also adds an introduction / architecture documentation that briefly touches on different ways of implementing components. The documentation structure is now formulated in a way that the already existing components are introduced first, then general server side component building and element API, and lastly the web component and template topics.

pleku added a commit that referenced this issue Jan 12, 2018
Fixes #1698

Moves all files around to make sure content is aligned into preferable reading order.
Also adds a very shallow introduction / architecture page.
pleku added a commit that referenced this issue Jan 15, 2018
Fixes #1698

Moves all files around to make sure content is aligned into preferable reading order.
Also adds a very shallow introduction / architecture page.
ZheSun88 pushed a commit that referenced this issue Jan 16, 2018
* Refactor the documentation structure

Fixes #1698

Moves all files around to make sure content is aligned into preferable reading order.
Also adds a very shallow introduction / architecture page.
@ZheSun88 ZheSun88 added this to the 1.0.0.alpha18 milestone Jan 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants