The Scala Website
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_books Update links Jan 28, 2018
_contribute_resources Add missing space Jan 27, 2018
_data fix typo Sep 9, 2018
_downloads Scala 2.13.0-M5 is here Aug 30, 2018
_events fix typo Sep 25, 2018
_includes Merge pull request #902 from scalacenter/open-edx-front-page Jun 26, 2018
_layouts Merge pull request #897 from Philippus/keep-event-on-frontpage May 21, 2018
_online_courses Add links to the Open edX instance running our courses Jun 6, 2018
_plugins Remove unused custom mods May 17, 2018
_posts Fix broken Github commit links Sep 5, 2018
_sass Merge pull request #902 from scalacenter/open-edx-front-page Jun 26, 2018
_scala_items Remove deprecated sample from the 'concurrency&distribution' example Apr 15, 2018
_trainings Add Advanced Type Mechanics training Mar 17, 2018
bin add check for docker compose to bash scripts Feb 22, 2018
blog Add final modifications to scalac-profiling blog post Aug 6, 2018
community tweak wording Sep 10, 2018
contribute Fix contribute link Feb 16, 2018
documentation Update JDK link Jul 23, 2018
download Scala 2.13.0-M5 is here Aug 30, 2018
events Show current events on the upcoming events page until they are over May 17, 2018
feed Fix Atom feeds Aug 7, 2016
gsoc Fix links to make CI pass Jun 4, 2018
news/_posts Announce edX support for our MOOCs (#847) Feb 27, 2018
pastevents Show current events on the upcoming events page until they are over May 17, 2018
resources Update LambdAle logo Sep 2, 2018
training Filter upcoming trainings in the same way as events and in the frontpage May 17, 2018
vendor/bundle forcing vendor and vendor/bundle to exist Feb 17, 2018
.gitignore Added vendor folder to gitignore Nov 15, 2017
.travis.yml Fix-up last merge conflict Aug 2, 2018
Gemfile add a docker-compose.yaml Feb 16, 2018
Gemfile.lock #932 upgrade Jekyll to 3.8.x Jul 29, 2018
Procfile Further heroku configuration Jan 20, 2017
README.md Correction to spelling mistake: trie -> try Feb 23, 2018
Rakefile Restoring rakefile Jan 26, 2017
_config.yml excluded /bin from being served up Jul 14, 2018
app.json Testing multi-buildpack installation Jan 20, 2017
composer.json Added composer.json for heroku/php buildpack Jan 20, 2017
conduct.md canonical CoC URL is /conduct/, but also support /conduct.html Sep 12, 2017
config.ru Further heroku configuration Jan 20, 2017
docker-compose.yml renamed YAML file for good measure Feb 22, 2018
index.md Shorten IntelliJ name Jul 19, 2018
license.md Added license page Feb 9, 2017
platforms.md Scala Native blurb update May 2, 2017
robots.txt #46: the robots.txt file ready for production. Jul 30, 2013

README.md

scala-lang.org

This repository contains the source for scala-lang.org.

It does not contain the source for the docs.scala-lang.org subdomain. You can visit the docs.scala-lang repository if you are interested in contributing to the Scala documentation site.

Dependencies

To build the site you can either use Compose or Bundler. Compose is a good option if you are just getting started and want something simple. If you are already familiar with the Ruby ecosystem then Bundler might be the most comfortable for you.

Either way the site is built with Jekyll and is typeset mostly in Markdown.

Building the site

Make sure you are in the root directory of the cloned repository.

For Compose:

bin/serve

For Bundler:

bundle exec jekyll serve --incremental

Viewing the site

Regardless of your method of running Jekyll, the generated site is available at http://localhost:4000.

Editing the Site

YAML Front Matter

The "YAML Front Matter" is nothing more than the header on each page that you intend for Jekyll to parse. It contains information such as the name of the HTML template (layout) chosen for the specific document, and the title of the document. An example YAML front matter might look like:

---
layout: page
title: My page title
---

You can use these fields in the YAML front matter later in your document. For example, to make a header with the title of the document, in Markdown you would write:

---
layout: page
title: My page title
---

# {{ page.title }}

Body text here...

# {{ page.title }} would be rendered in HTML as, <h1>My page title</h1>.

Recommended Markdown Editor

Visual Studio Code has great support for Scala, Git, and Markdown.

Linking to internal pages

The least error-prone way to make links is to use this format: [link text]({{ site.baseurl }}/path/to/page/page.html)

{{ site.baseurl }} is a site-wide variable that represents the root directory of the static site. So, to display the Scala logo image you can simply write: ![Img alt text]({{ site.baseurl }}/resources/img/scala-logo.png)

Permalinks

We try to follow a pretty permalink style, so that any generated page will have a link finishing in a slash character (/). This will tell Jekyll to build that particular page as an index.html inside a folder with a name as specified in the provided permalink. i.e.: if a page has a permalink as follows:

permalink: /what-is-scala/

This will tell Jekyll to create a what-is-scala directory, with an index.html file inside. Links to this page will refer to the {{site.baseurl}}/what-is-scala/.

Custom collections and data

Every collection is a directory starting with an underscore character (_), containing a Markdown file for each member of the collection. These Markdown files start with a YAML front matter containing the data for this item, and can optionally contain markdown text to be rendered as html.

Right now there are no collections being rendered as specific pages in the site. They are only consumed internally as data. In the future this can be changed by specifying the global output: true variable in the _config.yml custom collections section. You will also need to specify a layout by using the defaults settings in the _config.yml file. i.e.:

defaults:
  - scope:
      path: ""
      type: collection_name
    values:
      layout: layout_name

To access data from a custom collection refer to site.<collection-name>. The collection's name will be the name of it's directory without the underscore character. i.e.: to access the data inside _downloads, use site.downloads.

Some of our data has been modelled as YAML files inside the _data folder. We generally do this for data that is used throughout the whole site. For example we do this for the navigation bar links.

The Backend

On every commit to the scala/scala-lang repository a jenkins job will generate the site using jekyll and copy the resulting files to the webserver. NOTE: the rsync of this job also deletes whatever is in the webserver directory with explicit exceptions: we need to keep the files listed below. Kind of a hack.

There are additional files on the webserver:

  • Subdirectory scala-lang.org/old is a static copy of the old website. It was generated once and copied there, and it stays like that.
  • Most of the files in /home/linuxsoft/archives/scala/ (on chara, accessible through ssh with your LAMP account) are synchronized to the subdirectory scala-lang.org/files/archive by another hourly jenkins job. This folder is used by the nightly and release jenkins jobs to publish scala releases:
    • distribution files (tarballs etc) in /
      • older distribution files, RCs in /old/ (not sure how exactly this is split up..)
    • api docs for distributions in /api/
    • nightly builds in /nightly/distributions/
    • nightly api builds in /nightly/docs-xxx/
    • nightly pdf builds (spec etc) in /nightly/pdfs