Skip to content

Overhauled documentation site design and structure #781

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

Closed
wants to merge 54 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
ac49a07
Update JSON, add redirect-from
travissarles May 5, 2017
cc88ed1
Guides to replace overviews landing
travissarles May 5, 2017
814e2a6
Updated description
travissarles May 5, 2017
d39f6cd
Ignore ruby version
travissarles May 8, 2017
d4b0479
updated json
travissarles May 26, 2017
4085615
jekyll-redirect-from
travissarles May 26, 2017
83cf79b
bumped scala version
travissarles May 26, 2017
531539d
Added redirect-from gem
travissarles May 26, 2017
6a03b97
New headers
travissarles May 26, 2017
970b29d
replaced layouts
travissarles May 26, 2017
ad2c2b0
new index page
travissarles May 26, 2017
6a62ca9
removed spanish overviews.index.md
travissarles May 26, 2017
2940964
replaced old resources
travissarles May 27, 2017
78c6e15
new images
travissarles May 27, 2017
3c3ab87
Getting started and docs landing pages
travissarles May 27, 2017
fb6231a
replaced tutorial layout
travissarles May 27, 2017
b442c58
changed overview layout
travissarles May 27, 2017
996b384
replaced sip layout with ipnm
travissarles May 27, 2017
07ea3b2
replaced guides-index layout
travissarles May 27, 2017
b7dfd58
fixed ipnm-landing typo
travissarles May 27, 2017
967d959
deleted partest guide
travissarles May 27, 2017
ed801fd
style index page
travissarles May 29, 2017
6caabcf
Fixed basics layout
travissarles May 29, 2017
d658a28
Merge branch 'copychanges'
travissarles May 29, 2017
8cf20c5
replaced redirected layout
travissarles May 29, 2017
0a0a8db
Updated layout
travissarles May 29, 2017
2eb980d
redirect tutorials index page to tour of scala
travissarles May 29, 2017
46552d1
Unused search page
travissarles May 29, 2017
94f2190
Fixed glossary
travissarles May 29, 2017
5999a0f
changed CNAME for running on github
travissarles May 29, 2017
2a68518
Fixed padding
travissarles May 29, 2017
aa4245c
Merge branch 'copychanges'
travissarles May 29, 2017
6cbc067
changed back CNAME
travissarles May 29, 2017
62a95a7
Updated links to glossary/cheatsheet
travissarles May 30, 2017
9f64f88
Updated layout for thanks
travissarles May 30, 2017
e9678b0
Updated contribute layout
travissarles May 30, 2017
1112f5d
fixed cheatsheet layout
travissarles May 30, 2017
ee0f6c5
fixed glossary layout
travissarles May 30, 2017
bc77126
fixed contributing header
travissarles May 30, 2017
9aff2f7
Merge branch 'copychanges'
travissarles May 30, 2017
8b1d76c
books collection
travissarles May 31, 2017
e604768
fixed formatting
travissarles May 31, 2017
ae23929
fixed urls
travissarles May 31, 2017
cd2d0b1
changed tour layout
travissarles May 31, 2017
18116b7
Merge branch 'copychanges'
travissarles May 31, 2017
de6ed33
Chagned tour layout
travissarles Jun 1, 2017
a98a8ec
Tour layout helpers
travissarles Jun 1, 2017
7edc511
Language bar fixed
travissarles Jun 1, 2017
ac489e8
Delete migrating from 2.7
travissarles Jun 3, 2017
8ae0c34
Language bar in contents bar
travissarles Jun 3, 2017
1627215
Merge branch 'copychanges'
travissarles Jun 3, 2017
31fdce9
Merge remote-tracking branch 'upstream/master' into testmerge
travissarles Jun 22, 2017
3bf9124
fixed merge conflicts
travissarles Jun 22, 2017
7979868
Merge branch 'master' into master
travissarles Jul 19, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
_site
.ruby-version
.DS_Store
.project
.settings
Expand Down
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docs.scala-lang.org
docs.scala-lang.org
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem 'jekyll-redirect-from'
4 changes: 3 additions & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ GEM
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
kramdown (1.13.2)
json (1.8.6)
kramdown (1.11.1)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
Expand Down Expand Up @@ -198,6 +199,7 @@ PLATFORMS

DEPENDENCIES
github-pages
jekyll-redirect-from

BUNDLED WITH
1.15.1
12 changes: 12 additions & 0 deletions _books/1-programming-in-scala-3rd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Programming in Scala, 3rd ed"
link: http://booksites.artima.com/programming_in_scala_3ed
image: /resources/img/books/ProgrammingInScala.gif
status: Updated for Scala 2.12
authors: ["Martin Odersky", "Lex Spoon", "Bill Benners"]
publisher:
---

(First edition [available for free online reading](http://www.artima.com/pins1ed/))

Being co-written by the language's designer, Martin Odersky, you will find it provides additional depth and clarity to the diverse features of the language. The book provides both an authoritative reference for Scala and a systematic tutorial covering all the features in the language. Once you are familiar with the basics of Scala you will appreciate having this source of invaluable examples and precise explanations of Scala on hand. The book is available from [Artima](http://booksites.artima.com/programming_in_scala_3ed). Award winning book - [Jolt Productivity award](http://www.drdobbs.com/joltawards/232601431) for Technical Books.
22 changes: 22 additions & 0 deletions _books/2-scala-for-the-impatient.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Scala for the Impatient"
link: http://www.horstmann.com/scala/index.html
image: /resources/img/books/scala_for_the_impatient.png
status: Available Now
authors: ["Cay S. Horstmann"]
publisher: Addison-Wesley
publisherLink: https://heuk.pearson.com/about-us.html/Addison-Wesley/
---

What you get:

* A rapid introduction to Scala for programmers who are competent in Java, C#, or C++
* Blog-length chunks of information that you can digest quickly
* An organization that you'll find useful as a quick reference

What you don't get:

* An introduction into programming or object-oriented design
* Religion about the superiority of one paradigm or another
* Cute or academic examples
* Mind-numbing details about syntax minutiae
11 changes: 11 additions & 0 deletions _books/3-programming-scala.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Programming Scala"
link: http://shop.oreilly.com/product/0636920033073.do
image: /resources/img/books/ProgrammingScala-final-border.gif
status: Updated for Scala 2.11
authors: ["Alex Payne", "Dean Wampler"]
publisher: O’Reilly
publisherLink: http://www.oreilly.com/
---

Both are industry experts, Alex Payne being the lead API programmer at Twitter, a social networking service based on Scala. O’Reilly, the publisher, writes: "Learn how to be more productive with Scala, a new multi-paradigm language for the Java Virtual Machine (JVM) that integrates features of both object-oriented and functional programming. With this book, you'll discover why Scala is ideal for highly scalable, component-based applications that support concurrency and distribution. You'll also learn how to leverage the wealth of Java class libraries to meet the practical needs of enterprise and Internet projects more easily."
11 changes: 11 additions & 0 deletions _books/4-functional-programming-in-scala.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Functional Programming in Scala"
link: https://www.manning.com/books/functional-programming-in-scala
image: /resources/img/books/FPiS_93x116.png
status: Available now
authors: ["Paul Chiusano", "Rúnar Bjarnason"]
publisher: Manning
publisherLink: http://www.manning.com/
---

"Functional programming (FP) is a style of software development emphasizing functions that don't depend on program state... Functional Programming in Scala is a serious tutorial for programmers looking to learn FP and apply it to the everyday business of coding. The book guides readers from basic techniques to advanced topics in a logical, concise, and clear progression. In it, you'll find concrete examples and exercises that open up the world of functional programming."
11 changes: 11 additions & 0 deletions _books/5-scala-in-depth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Scala in Depth"
link: http://www.manning.com/suereth
image: /resources/img/books/icon_Scala_in_Depth_93x116.png
status: Available now
authors: ["Joshua D. Suereth"]
publisher: Manning
publisherLink: http://www.manning.com/
---

"While information about the Scala language is abundant, skilled practitioners, great examples, and insight into the best practices of the community are harder to find. Scala in Depth bridges that gap, preparing you to adopt Scala successfully for real world projects. Scala in Depth is a unique new book designed to help you integrate Scala effectively into your development process. By presenting the emerging best practices and designs from the Scala community, it guides you though dozens of powerful techniques example by example. There's no heavy-handed theory here-just lots of crisp, practical guides for coding in Scala."
11 changes: 11 additions & 0 deletions _books/6-scala-puzzlers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Scala Puzzlers"
link: http://www.artima.com/shop/scala_puzzlers
image: /resources/img/books/icon_Scala_in_Depth_93x116.png
status: Available now
authors: ["Andrew Phillips", "Nermin Šerifović"]
publisher: Artima Press
publisherLink: http://www.artima.com/index.jsp
---

"Getting code to do what we want it to do is perhaps the essence of our purpose as developers. So there are few things more intriguing or important than code that we think we understand, but that behaves rather contrary to our expectations. Scala Puzzlers is a collection of such examples in Scala. It is not only an entertaining and instructive way of understanding this highly expressive language better. It will also help you recognize many counter-intuitive traps and pitfalls and prevent them from inflicting further production bug hunt stress on Scala developers."
6 changes: 5 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ keywords:
- Document
- Guide

scala-version: 2.12.0
collections:
books:
output: false

scala-version: 2.12.2

highlighter: rouge
permalink: /:categories/:title.html
Expand Down
12 changes: 12 additions & 0 deletions _data/nav-header.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
- title: Documentation
url: /
- title: Download
url: https://www.scala-lang.org/download/
- title: Community
url: https://www.scala-lang.org/community/
- title: Libraries
url: https://index.scala-lang.org
- title: Contribute
url: https://www.scala-lang.org/contribute/
- title: Blog
url: https://www.scala-lang.org/blog/
28 changes: 0 additions & 28 deletions _includes/allsids.txt

This file was deleted.

75 changes: 75 additions & 0 deletions _includes/blog-list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{% comment %}Use the include variable 'category' to select the category to show (included in blog-categories.yml), or assign it to "all" if you want to show all posts.{% endcomment %}

<section class="content">
<div class="wrap">
<div class="content-primary-blog">
<div class="inner-box">
<ul class="nav-tab">
<li class="item-tab"><a {% if page.category == "all" %}class="active"{% endif %} href="/blog/">All</a></li>
{% for category in site.data.blog-categories %}
<li class="item-tab">
<a {% if category.categoryId == include.category %}class="active"{% endif %} href="{{category.url}}">{{category.title}}</a>
</li>
{% endfor %}
</ul>
<div class="blog-list">
{% for post in paginator.posts %}
<div class="blog-item">
<h2><a href="{{post.url}}">{{post.title}}</a></h2>
<p class="blog-date">{{post.date | date: "%A %-d %B %Y"}}</p>
{% if post.by %}<p class="blog-author">{{post.by}}</p>{% endif %}
{% if post.tags %}
<ul class="tag-list">
{% for tag in post.tags %}
<li class="tag-item">{{tag}}</li>
{% endfor %}
</ul>
{% endif %}
</div>
{% endfor %}
</div>
</div>
{% for category in site.data.blog-categories %}
{% if category.categoryId == include.category %}
{% assign currentCategoryPath = category.url %}
{% endif %}
{% endfor %}

{% capture urlPath %}{% if include.category == "all" %}blog{% else %}{{currentCategoryPath}}{% endif %}{% endcapture %}
{% assign urlPath = urlPath | split: '/' | join: '/' | remove_first: '/' %}
{% include paginator.html urlPath=urlPath %}
</div>
{% assign highlights = "" | split: "," %}
{% for post in site.posts %}
{% if post.isHighlight == true %}
{% assign highlights = highlights | push: post %}
{% endif %}
{% endfor %}

{% for post in highlights %}
{% if forloop.first %}
<div class="content-nav-blog">
<div class="inner-box">
<h5>Highlights</h5>
<div class="blog-list-nav">
{% endif %}
<div class="blog-list-nav-item">
<h4><a href="{{post.url}}">{{post.title}}</a></h4>
{% if post.by %}<p>{{post.by}}</p>{% endif %}
{% if post.tags %}
{% for tag in post.tags %}
<ul class="tag-list">
<li class="tag-item">{{tag}}</li>
</ul>
{% endfor %}
{% endif %}
</div>
{% if forloop.last %}
</div>
</div>
</div>
{% endif %}
{% endfor %}

</div>
</section>
31 changes: 9 additions & 22 deletions _includes/cheatsheet-header.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,22 @@
<html>
<head>

<title>{% if page.title %}{{ page.title }} - {% endif %}{{ site.title }}</title>
{% if page.description %}
<meta name="description" content="{{ page.description }}" />
{% endif %}
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

<link rel="icon" type="image/png" href="{{ site.baseurl }}/resources/favicon.ico">

<!-- prettify js and CSS -->
<link rel="stylesheet" href="{{ site.baseurl }}/resources/stylesheets/prettify.css" type="text/css" />
<script src="{{ site.baseurl }}/resources/javascript/prettify/prettify.js" type="text/javascript" ></script>
<link rel="stylesheet" href="{{ site.baseurl }}/resources/css/prettify.css" type="text/css" />
<script src="{{ site.baseurl }}/resources/js/vendor/prettify/prettify.js" type="text/javascript" ></script>

<!-- jquery js -->
<script src="{{ site.baseurl }}/resources/javascript/jquery.js" type="text/javascript" ></script>
<script src="{{ site.baseurl }}/resources/js/jquery.js" type="text/javascript" ></script>

<!-- Bootstrap JS and CSS -->
<link rel="stylesheet" href="{{ site.baseurl }}/resources/stylesheets/bootstrap.css" type="text/css" />
<script src="{{ site.baseurl }}/resources/javascript/bootstrap-dropdown.js" type="text/javascript" ></script>
<script src="{{ site.baseurl }}/resources/javascript/bootstrap-dropdown-app.js" type="text/javascript" ></script>
<link rel="stylesheet" href="{{ site.baseurl }}/resources/css/bootstrap.css" type="text/css" />
<script src="{{ site.baseurl }}/resources/js/bootstrap-dropdown.js" type="text/javascript" ></script>
<script src="{{ site.baseurl }}/resources/js/bootstrap-dropdown-app.js" type="text/javascript" ></script>

<!-- Base stylesheet for all pages -->
<link rel="stylesheet" href="{{ site.baseurl }}/resources/stylesheets/base.css" type="text/css" />
<link rel="stylesheet" href="{{ site.baseurl }}/resources/css/base.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
<link rel="stylesheet" href="{{ site.baseurl }}/resources/stylesheets/search.css" type="text/css" />

<!-- table of contents js -->
<script src="{{ site.baseurl }}/resources/javascript/toc.js" type="text/javascript" ></script>
<link rel="stylesheet" href="{{ site.baseurl }}/resources/css/search.css" type="text/css" />

<!-- google analytics -->
<script type="text/javascript">
Expand Down Expand Up @@ -90,9 +79,8 @@

<style type="text/css">
html, body {
padding-top: 36px;
padding-top: 0px;
height: 100%;
background:url({{ site.baseurl }}/resources/images/bg-short.jpg) no-repeat top center #310808;
-webkit-box-shadow: inset 0 10px 50px rgba(0,0,0,.6);
-moz-box-shadow: inset 0 10px 50px rgba(0,0,0,.6);
/* box-shadow: inset 0 10px 30px rgba(0,0,0,.3);*/
Expand All @@ -118,7 +106,6 @@
min-height: 100%;
background-color: #ffffff;
padding-top: 20px;
border-top: 1px solid #8e397d;
}
.bottom h1,h2,h3 {
text-shadow: 0 1px 2px rgba(255,255,255,.5);
Expand Down
40 changes: 0 additions & 40 deletions _includes/cheatsheet-sidebar.txt

This file was deleted.

4 changes: 0 additions & 4 deletions _includes/collections.txt

This file was deleted.

18 changes: 18 additions & 0 deletions _includes/column-list-of-items.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{% comment %}
Layouts using this include should pass an include variable called 'collection' referencing a collection carrying the data (i.e.: contribute_community_tickets, contribute_resources...)
{% endcomment %}
<div class="documentation">
{% for item in include.collection %}
<div class="doc-item">
<div class="doc-item-header">
<i class="{{item.icon}}"></i>
<a href="{{item.link}}">
<h4>{{item.title}}</h4>
</a>
</div>
<div class="doc-item-main">
{{item.content}}
</div>
</div>
{% endfor %}
</div>
8 changes: 0 additions & 8 deletions _includes/contributing-header.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@
<html>
<head>

<title>{% if page.title %}{{ page.title }} - {% endif %}{{ site.title }}</title>
{% if page.description %}
<meta name="description" content="{{ page.description }}" />
{% endif %}
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

<link rel="icon" type="image/png" href="{{ site.baseurl }}/resources/favicon.ico">

<!-- prettify js and CSS -->
<link rel="stylesheet" href="{{ site.baseurl }}/resources/stylesheets/prettify.css" type="text/css" />
<script src="{{ site.baseurl }}/resources/javascript/prettify/prettify.js" type="text/javascript" ></script>
Expand Down
Loading