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.

Sign up for GitHub

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

Jump to bottom

New getting-started series #608

Merged

heathermiller merged 2 commits into scala:master from travissarles:getting-started

Jul 13, 2017

Contributor

travissarles commented Feb 28, 2017

No description provided.

Member

lrytz commented Feb 28, 2017

Very nice! While looking at the preview of #606, this was exactly the kind of information I found missing on the current website.

I think the command-line/sbt vs InteliJ split is a bit too strict: I would personally create a new project with sbt new and then open it up in IntelliJ. In practice I often switch between the two, sometimes running (and debugging!) tests within IJ, sometimes running them on the console.

It also shows in your texts: there's duplication in two pages in "Let's go over this line by line".

Another thing: It would be nice to introduce the REPL and IntelliJ worksheets.

Member

heathermiller commented Feb 28, 2017

Hey @lrytz there was actually a raging debate at the SC about whether or not to start with sbt new in the IntelliJ tutorial.

Even though all of us who actually use Scala to do real things would prefer to start with sbt new, we ended up trying to keep the first IntelliJ tutorial sbt-free, so as not to overwhelm newcomers with setup instructions. For "Hello, World!" and most other basic exercises that one would do when learning Scala, just using IntelliJ only is sufficient. That was the idea anyway – we all kind of agreed that it would make sense to say "well if you want to do anything real, like adding dependencies, etc, you're going to need sbt" but for the first breath of experience with Scala we thought that it was enough to try to keep setup as minimal as possible, which meant no sbt in step 0 of IntelliJ.

Member

SethTisue commented Feb 28, 2017

we ended up trying to keep the first IntelliJ tutorial sbt-free

👍

perhaps there's somewhere Lukas's remarks could be incorporated anyway, like in a sort of footnote or aside later on.

Member

lrytz commented Feb 28, 2017

OK, I see. Maybe a middle ground would be to merge the two paths where it talks about adding tests, to avoid some duplication? Also, the sbt/console section could mention that it's easy (and recommended?) to import an sbt project into IJ.

Contributor Author

travissarles commented Mar 14, 2017

@heathermiller ready to merge

SethTisue requested changes

View reviewed changes

...ation/getting-started-intellij-track/building-a-scala-project-with-intellij-and-sbt.markdown Outdated

		@@ -0,0 +1,94 @@
		# Building a Scala project with IntelliJ and sbt

		In this tutorial, we'll see how to build a Scala project [sbt](http://www.scala-sbt.org/0.13/docs/index.html). sbt is the

Member

SethTisue Mar 14, 2017

missing word here ("with" or "using" sbt)

...ation/getting-started-intellij-track/building-a-scala-project-with-intellij-and-sbt.markdown Outdated

+              # Building a Scala project with IntelliJ and sbt
+              In this tutorial, we'll see how to build a Scala project [sbt](http://www.scala-sbt.org/0.13/docs/index.html). sbt is the
+              de facto tool for compiling, running, and testing Scala projects of any

Member

SethTisue Mar 14, 2017

I'm a bit concerned here about giving the impression that sbt is your only choice and e.g. maven and gradle aren't also options. Suggested:

change "de facto" to "a common, standard"
change "It becomes essential" to "Using a build tool becomes essential"
add some words like "Maven, Gradle, and other popular build tools can also build Scala projects."

...ation/getting-started-intellij-track/building-a-scala-project-with-intellij-and-sbt.markdown Outdated

+              ## Creating the project
+              In this section, we'll show you how to create the project in IntelliJ. However, if you're
+              comfortable with the command line, we recommend you try [Getting
+              started with Scala with sbt in the command line](https://link) and then come back

Member

SethTisue Mar 14, 2017

missing link here

...ation/getting-started-intellij-track/building-a-scala-project-with-intellij-and-sbt.markdown Outdated

+              sbt creates many directories which can be useful once you start building
+              more complex projects. You can ignore most of them for now
+              but here's a glance at what everything is for:
+              ```

Member

SethTisue Mar 14, 2017

I think you'll need a blank line before the triple backquotes

...ation/getting-started-intellij-track/building-a-scala-project-with-intellij-and-sbt.markdown Outdated

+              extra functionality to our apps.
+. Open up `build.sbt` and add the following line:
+              ```
+              libraryDependencies += "org.typelevel" %% "cats" % "0.9.0"

Member

SethTisue Mar 14, 2017

I'm afraid I don't think this is a good choice of example library. I would suggest a Scala module such as scala-xml or scala-parser-combinators.

documentation/getting-started-intellij-track/getting-started-with-scala-in-intellij.markdown Outdated

+              * Change the code in the class to the following:
+              ```tut
+              object Hello extends App {
+                  println("Hello, World!")

Member

SethTisue Mar 14, 2017

indent 2 spaces, not 4

documentation/getting-started-intellij-track/testing-scala-in-intellij-with-scalatest.markdown Outdated

+              There are multiple libraries and testing methodologies for Scala,
+              but in this tutorial, we'll demonstrate one popular option from the scalatest framework
+              called [FunSuite](http://www.scalatest.org/getting_started_with_fun_suite).
+              We assume you know [how to build a project in IntelliJ](https://linktotutorial).

Member

SethTisue Mar 14, 2017

needs proper link

documentation/getting-started-intellij-track/testing-scala-in-intellij-with-scalatest.markdown Outdated

+              ```
+              libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.1" % "test"
+              ```
+              * this will cause sbt to pull down the scalatest library

Member

SethTisue Mar 14, 2017

s/scalatest/ScalaTest/

documentation/getting-started-sbt-track/testing-scala-with-sbt-in-the-command-line.markdown Outdated

+              ## Conclusion
+              You've seen one way to test your Scala code. You can learn more about
+              scalatest's FunSuite on the [official website](http://www.scalatest.org/getting_started_with_fun_suite).

Member

SethTisue Mar 14, 2017

suggest adding: Other popular testing frameworks for Scala include ScalaCheck (link) and Specs2 (link).

SethTisue mentioned this pull request

push sbt more for getting-started...? #536

Closed

SethTisue added the WIP label

SethTisue added good first issue and removed good first issue labels

travissarles mentioned this pull request

SCP-008: Maintain scala-lang, docs.scala-lang, scala.epfl.ch websites scalacenter/advisoryboard#24

Closed

24 tasks

SethTisue approved these changes

View reviewed changes

Member

ashawley commented Apr 24, 2017 •

edited

Loading

This looks really helpful. I tried running it locally, but didn't get far. Seems the following are needed:

Rename files to .md for consistencies sake?
Add front matter
These are new pages, but how do you get to them? Link(s) from main getting started page?
Maybe rebase against master? Seems this branch is 346 commits behind master.

Contributor Author

travissarles commented Apr 25, 2017

@ashawley thanks for the review. I will do those things.

travissarles force-pushed the getting-started branch from e689a89 to a994037 Compare

April 25, 2017 14:15


          New getting-started series

a088cec

travissarles force-pushed the getting-started branch from a994037 to a088cec Compare

April 26, 2017 12:10

Member

heathermiller commented Jul 13, 2017

Will finish this.

heathermiller self-assigned this


          Merge branch 'master' into getting-started

fc0d110

heathermiller merged commit fc0d110 into scala:master

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

Labels

WIP