Skip to content

recommend sbt, not Activator #530

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

Merged
merged 2 commits into from
Nov 16, 2016
Merged

recommend sbt, not Activator #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7f8b72
recommend sbt, not Activator
SethTisue Nov 15, 2016
05a0ff5
link to sbt landing page
SethTisue Nov 16, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions _layouts/downloadpage.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,12 @@
<div class="bigcircle" style="float: right;">2</div>
<div class="bigcircle-content" style="float: right; margin-top: 32px;">
<p class="center" style="text-align: right;">
<b><a href="http://www.lightbend.com/activator/">Get started with Lightbend Activator</a></b>
<b><a href="http://www.scala-sbt.org/">Get started with sbt</a></b>
<br/>
Lightbend Activator is a browser-based or command-line<br/>
tool that helps developers get started with Scala.
<div class="download-wrapper">
<a id="download-button" class="activator" style="margin-top: 12px; margin-right: 24px; width: 200px;" href="http://downloads.lightbend.com/typesafe-activator/1.2.10/typesafe-activator-1.2.10.zip">
<span class="slider">Download</span>
<span class="activator icon"></span>
<span class="version-long">&nbsp;Lightbend Activator</span>
</a>
<p class="install"><a style="margin-left: 124px;" href="http://www.lightbend.com/activator/download">Need help installing?</a></p>
</div>
sbt is a popular build tool for Scala projects.<br/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should sbt be capitalized here? It is the beginning of a sentence.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sbt is a proper noun like iPhone and eBay.

With sbt, you don't need to download and install Scala.<br/>
Just set <code>scalaVersion</code> in your build definition,<br/>
and sbt will retrieve that version.
</p>
</div>
</div>
Expand Down
8 changes: 0 additions & 8 deletions contribute/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ title: Documentation Contributions
There are several ways you can help out with the improvement of Scala documentation. These include:

* API Documentation in Scaladoc
* Code examples and tutorials in activator templates.
* Guides, Overviews, Tutorials, Cheat Sheets and more on the docs.scala-lang.org site
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sbt 13.13 has a new command that provides templates. Maybe this is worth mentioning.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible for sbt to provide some examples for basic projects?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it would be good to link people to either documentation about new or some kind of template. @dwijnand and/or @eed3si9n, do you have any suggestions here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway, this is the wrong place to suggest these changes. I think we're making suggestions for improving the getting started page, which is not the file we're commenting on (we're commenting on a contributing page)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the getting started page, you can point to http://www.scala-sbt.org/0.13/docs/sbt-new-and-Templates.html

* Updating scala-lang.org

Expand All @@ -28,13 +27,6 @@ Please *follow the issue submission process closely* to help prevent duplicate i
[submit new Scaladoc](./scala-standard-library-api-documentation.html)
without creating an issue, but please look to see if there is an issue already submitted for your task and claim it if there is. If not, please post your intention to work on a specific scaladoc task on scala-internals so that people know what you are doing.

### Examples/Tutorials in Activator Templates

[Lightbend Activator](https://www.lightbend.com/community/core-tools/activator-and-sbt)
is a tool based on SBT, with a UI mode that is ideal for code based tutorials, overviews and walk-throughs. To contribute an example in activator, you can fork an existing template, edit it, add a tutorial, upload it to github and then submit the github project into the template repository. It's the fastest way to produce a working code example with tutorial.

Please see [Contributing an Activator Template](https://www.lightbend.com/activator/template/contribute) for more details.

### The Main Scala Documentation Site

[docs.scala-lang.org](https://wiki.scala-lang.org/) houses the primary source of written, non-API documentation for Scala. It's a github project that you can fork and submit pull requests from. It includes:
Expand Down
2 changes: 1 addition & 1 deletion contribute/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Coordination of contribution efforts takes place on the
<div class="row">
<div class="span4 doc-block">
<h4><a href="./documentation.html">Documentation</a></h4>
<p><a href="./scala-standard-library-api-documentation.html">Scaladoc (API)</a>, <a href="https://www.lightbend.com/activator/template/contribute">Activator templates</a>,
<p><a href="./scala-standard-library-api-documentation.html">Scaladoc (API)</a>,
<a href="http://docs.scala-lang.org/contribute.html">docs.scala-lang.org</a> and
<a href="https://github.com/scala/scala-lang">scala-lang.org</a>.</p>
</div>
Expand Down
1 change: 0 additions & 1 deletion news/_posts/2016-03-08-release-notes-2.11.8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ Scala releases are available through a variety of channels, including (but not l
* Download a distribution from [scala-lang.org](http://scala-lang.org/download/2.11.8.html)
* Bump the `scalaVersion` setting in your SBT-based project
* Obtain JARs via [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.scala-lang%22%20AND%20v%3A%222.11.8%22)
* Try the [Hello Scala 2.11 template](https://www.lightbend.com/activator/template/hello-scala-2_11) in [Lightbend Activator](https://www.lightbend.com/activator/download)

### Scala 2.11 Notes

Expand Down
13 changes: 1 addition & 12 deletions resources/css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,8 +254,7 @@ a.brand {
padding-left: 20px;
margin-right: 0;
}
#download-button .icon,
#download-button .activator .icon {
#download-button .icon {
width: 26px;
height: 26px;
margin: 7px;
Expand All @@ -272,13 +271,6 @@ a.brand {
-o-transform: translateX(0);
transform: translateX(0);
}
#download-button:hover.activator span {
-webkit-transform: translateX(24px);
-moz-transform: translateX(24px);
-ms-transform: translateX(24px);
-o-transform: translateX(24px);
transform: translateX(24px);
}

/* Ideally, we would have only this:
#download-button:hover .icon {
Expand Down Expand Up @@ -311,9 +303,6 @@ a.brand {
#download-button.unix:hover .icon {
background-position: -52px -26px;
}
#download-button.activator .icon {
background-position: 0 -26px;
}

#getting-started-popup {
position: fixed;
Expand Down
19 changes: 0 additions & 19 deletions resources/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,30 +187,11 @@ function styleCode() {

$(document).ready(function() {

// get the most up-to-date version of activator
$.getJSON("https://activator-prod.herokuapp.com/latest?callback=?", function(data) {
// update the page with the latest values
if (data.version != undefined) {
var activatorLink = $("#download-button.activator")
activatorLink.prop("href", "http://downloads.lightbend.com/typesafe-activator/" + data.version + "/typesafe-activator-" + data.version + ".zip")
}
})

var os = getOS();
if (os == "Unknown OS") os = "UNIX";

var osLabel = os.replace(/\s/g, '').toLowerCase();

// Removing the automatic download on the front page in favor of a
// link to the download page so people can see that activator is also
// a valid download choice.
// $("#main-download-button").each(function() {
// var unixLink = "{{ site.scala_maindownload_unix }}",
// windowsLink = "{{ site.scala_maindownload_windows }}",
// link = (os == "Windows") ? windowsLink : unixLink;
// $(this).attr("href", link).addClass(osLabel);
// });

// Do not do any of the following if we're not on a download page
// Otherwise a TypeError is raised and disables all other scripts on the page
if ($("#download-button").length == 0)
Expand Down