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

Update getting-started-scala.asciidoc #9418

Merged
merged 6 commits into from Aug 7, 2017

Conversation

Projects
None yet
4 participants
@serragnoli
Copy link
Contributor

serragnoli commented May 23, 2017

As per recommendation of Fredrik Rönnlund following my post on https://dzone.com/articles/working-vaadin-with-scala


This change is Reviewable

@CLAassistant

This comment has been minimized.

Copy link

CLAassistant commented May 23, 2017

CLA assistant check
All committers have signed the CLA.

@hesara

This comment has been minimized.

Copy link
Contributor

hesara commented May 26, 2017

Review status: 0 of 1 files reviewed at latest revision, 4 unresolved discussions.


documentation/getting-started/getting-started-scala.asciidoc, line 23 at r1 (raw file):

_Note that at this point you could import the project to and IDE like IntelliJ._

* You now should have the Vaadin Java project under the directoy `ui`. Since we are doing Scala, delete the `java` directory in `${project_home}/src/main/` and create an empty `scala` directory in the same place. 

directoy -> directory


documentation/getting-started/getting-started-scala.asciidoc, line 35 at r1 (raw file):

  </dependency>
 </dependencies>
 <plugins>

this is a bit misleading as the "plugins" section should be inside the "build" section, and the example has the root level "project" directly above it


documentation/getting-started/getting-started-scala.asciidoc, line 58 at r1 (raw file):

* Create the following class in the new-created `scala` directory.
```scala

I'm not sure if all our documentation build tools handle this syntax for all the languages mentioned (xml, bash, scala), or if we should use the syntax
"
[source, scala]

...

"

@Artur- might know better


documentation/getting-started/getting-started-scala.asciidoc, line 110 at r1 (raw file):

* Go to `localhost:8080` from the web browser and the page should be working:

image::https://cloud.githubusercontent.com/assets/4601281/26378300/da317d92-400b-11e7-9118-fd2b3b9cc942.png[]

we probably want to put the related images in the same repo as the documentation


Comments from Reviewable

@Artur-

This comment has been minimized.

Copy link
Member

Artur- commented May 26, 2017

Review status: 0 of 1 files reviewed at latest revision, 4 unresolved discussions.


documentation/getting-started/getting-started-scala.asciidoc, line 58 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

I'm not sure if all our documentation build tools handle this syntax for all the languages mentioned (xml, bash, scala), or if we should use the syntax
"
[source, scala]

...

"

@Artur- might know better

Sorry, don't know


Comments from Reviewable

@serragnoli

This comment has been minimized.

Copy link
Contributor Author

serragnoli commented May 26, 2017

Review status: 0 of 1 files reviewed at latest revision, 4 unresolved discussions.


documentation/getting-started/getting-started-scala.asciidoc, line 23 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

directoy -> directory

Is this comment related to the repetition of the word "directory"?


documentation/getting-started/getting-started-scala.asciidoc, line 35 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

this is a bit misleading as the "plugins" section should be inside the "build" section, and the example has the root level "project" directly above it

Agreed. I've removed the misleading part and split the xml in two units.


documentation/getting-started/getting-started-scala.asciidoc, line 58 at r1 (raw file):

Previously, Artur- (Artur) wrote…

Sorry, don't know

I chose that syntax because the original one '[source, scala]' looked bad in the GitHub preview tool.
I've left it as it as until we know the syntax cannot be handled.


documentation/getting-started/getting-started-scala.asciidoc, line 110 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

we probably want to put the related images in the same repo as the documentation

Is that something I can do myself?


Comments from Reviewable

@hesara

This comment has been minimized.

Copy link
Contributor

hesara commented May 29, 2017

Review status: 0 of 1 files reviewed at latest revision, 3 unresolved discussions.


documentation/getting-started/getting-started-scala.asciidoc, line 23 at r1 (raw file):

Previously, serragnoli (Fabio Serragnoli) wrote…

Is this comment related to the repetition of the word "directory"?

no, there is a typo in the word early in the sentence


documentation/getting-started/getting-started-scala.asciidoc, line 58 at r1 (raw file):

Previously, serragnoli (Fabio Serragnoli) wrote…

I chose that syntax because the original one '[source, scala]' looked bad in the GitHub preview tool.
I've left it as it as until we know the syntax cannot be handled.

Somebody (from Vaadin) needs to try to build the paper book/PDF with these to test these, then.


documentation/getting-started/getting-started-scala.asciidoc, line 110 at r1 (raw file):

Previously, serragnoli (Fabio Serragnoli) wrote…

Is that something I can do myself?

Yes - there is an img folder under getting-started, and the other getting-started documents use the correct syntax for referencing these. Note that we sometimes need custom syntax/path for the book build tools to work etc. and these might not be 100% the same as GitHub preview format.


Comments from Reviewable

@serragnoli

This comment has been minimized.

Copy link
Contributor Author

serragnoli commented May 30, 2017

Review status: 0 of 2 files reviewed at latest revision, 3 unresolved discussions.


documentation/getting-started/getting-started-scala.asciidoc, line 23 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

no, there is a typo in the word early in the sentence

Seen it now.
Done.


documentation/getting-started/getting-started-scala.asciidoc, line 110 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

Yes - there is an img folder under getting-started, and the other getting-started documents use the correct syntax for referencing these. Note that we sometimes need custom syntax/path for the book build tools to work etc. and these might not be 100% the same as GitHub preview format.

Done.


Comments from Reviewable

@hesara

This comment has been minimized.

Copy link
Contributor

hesara commented Aug 7, 2017

Reviewed 2 of 2 files at r3.
Review status: all files reviewed at latest revision, 1 unresolved discussion.


documentation/getting-started/getting-started-scala.asciidoc, line 58 at r1 (raw file):

Previously, hesara (Henri Sara) wrote…

Somebody (from Vaadin) needs to try to build the paper book/PDF with these to test these, then.

Merging this and testing the documentation build after merge, will fix if necessary.


Comments from Reviewable

@hesara hesara merged commit b07c97b into vaadin:master Aug 7, 2017

3 checks passed

code-review/reviewable 2 files reviewed
Details
license/cla Contributor License Agreement is signed.
Details
verification-build/teamcity Finished TeamCity Build Vaadin Framework :: Active Projects :: Framework GitHub Validation Build : Tests passed: 5018, ignored: 194
Details

@hesara hesara added this to the 8.1.2 milestone Aug 7, 2017

Flamenco added a commit to Flamenco/vaadin that referenced this pull request Aug 9, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment