Skip to content

Commit 659f076

Browse files
bishaboshabishabosha
authored
Merge pull request #2388 from bishabosha/get-started-os-options
Put OS-specific get-started instructions in tabs
2 parents f800c7f + 5bdcacd commit 659f076

29 files changed

+481
-224
lines changed

‎_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ scala-3-version: 3.1.2
2121

2222
collections:
2323
contribute_resources:
24+
output: false
25+
install_tabs:
26+
output: false
2427
style:
2528
output: true
2629
overviews:

‎_data/setup-scala.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
linux: curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux.gz | gzip -d > cs && chmod +x cs && ./cs setup
2+
macOS-default: curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-apple-darwin.gz | gzip -d > cs && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup
3+
macOS-brew: brew install coursier/formulas/coursier && cs setup
4+
windows-link: https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-win32.zip

‎_fr/getting-started/index.md

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,15 @@ Nous recommandons l'utilisation de l'outil d'installation "Coursier" qui va auto
2424
### Utilisation de l'installateur Scala (recommandé)
2525

2626
L'installateur Scala est un outil nommé [Coursier](https://get-coursier.io/docs/cli-overview), la commande principale de l'outil est `cs`.
27-
Il s'assure que la JVM est les outils standards de Scala sont installés sur votre système.
27+
Il s'assure que la JVM est les outils standards de Scala sont installés sur votre système.
2828
Installez-le sur votre système avec les instructions suivantes.
2929

3030
<div class="main-download">
31-
<div id="download-step-one">
32-
<p>Suivez <a href="https://get-coursier.io/docs/cli-installation.html#native-launcher" target="_blank">les instructions pour installer la commande <code>cs</code></a> puis exécutez :</p>
33-
<p><code>$ ./cs setup</code></p>
31+
<div class="recommended-install">
32+
<div class="place-inline">
33+
{% include tabsection.html language='fr' id='install-cs-setup-tabs' collection=site.install_tabs %}
34+
</div>
35+
<!-- TODO: translate 'Test your setup' from _includes/getting-started.md, embellish tabs -->
3436
</div>
3537
</div>
3638

@@ -165,30 +167,3 @@ Une fois que vous avez terminé le tutoriel ce dessus, vous pouvez consulter :
165167
Il y a plusieurs listes de diffusion et canaux de discussions instantanés si vous souhaitez rencontrer rapidement d'autres utilisateurs de Scala. Allez faire un tour sur notre page [community](https://scala-lang.org/community/) pour consulter la liste des ces ressources et obtenir de l'aide.
166168
167169
Traduction par Antoine Pointeau.
168-
169-
<!-- Hidden elements whose content are used to provide OS-specific download instructions.
170-
-- This is handled in `resources/js/functions.js`.
171-
-->
172-
<div style="display:none" id="stepOne-linux">
173-
<code class="hljs">$ curl -fLo cs https://git.io/coursier-cli-linux && chmod +x cs && ./cs setup </code> <br>
174-
</div>
175-
176-
<div style="display:none" id="stepOne-unix">
177-
<p>Suivez <a href="https://get-coursier.io/docs/cli-installation" target="_blank">les instructions pour installer la commande
178-
<code>cs</code></a>puis exécutez :</p>
179-
<p><code>$ ./cs setup</code></p>
180-
</div>
181-
182-
<div style="display:none" id="stepOne-osx">
183-
<div class="highlight">
184-
<code class="hljs">$ brew install coursier/formulas/coursier && cs setup </code> <br>
185-
</div>
186-
<p>Alternativement, si vous n'utilisez pas Homebrew</p>
187-
<div class="highlight">
188-
<code class="hljs">$ curl -fLo cs https://git.io/coursier-cli-macos && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup</code> <br>
189-
</div>
190-
</div>
191-
192-
<div style="display:none" id="stepOne-windows">
193-
<p>Téléchargez et exécutez <a href="https://git.io/coursier-cli-windows-exe">l'intallateur Scala pour Windows</a> basé sur Coursier</p>
194-
</div>

‎_includes/_ja/getting-started.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ Scala のインストーラーは[Coursier](https://get-coursier.io/docs/cli-ove
1818
以下の手順でお使いのシステムにインストールしてください。
1919

2020
<div class="main-download">
21-
<div id="download-step-one">
22-
<p>Follow <a href="https://get-coursier.io/docs/cli-installation.html#native-launcher" target="_blank">the instructions to install the <code>cs</code> launcher</a> then run:</p>
23-
<p><code>$ ./cs setup</code></p>
21+
<div class="recommended-install">
22+
<div class="place-inline">
23+
{% include tabsection.html language='ja' id='install-cs-setup-tabs' collection=site.install_tabs %}
24+
</div>
25+
<!-- TODO: translate 'Test your setup' from _includes/getting-started.md, embellish tabs -->
2426
</div>
2527
</div>
2628

27-
2829
`cs setup` は JVM の管理だけでなく、便利なコマンドラインツールもインストールします:
2930

3031
- JDK (インストール済みでなければ)
@@ -141,29 +142,3 @@ IDE の使用に慣れている場合は、IDE から_Main.scala_のコードを
141142
142143
### (日本語のみ追記)
143144
Scala について日本語で質問したい場合、Twitterでつぶやくと気づいた人が教えてくれます。
144-
145-
<!-- Hidden elements whose content are used to provide OS-specific download instructions.
146-
-- This is handled in `resources/js/functions.js`.
147-
-->
148-
<div style="display:none" id="stepOne-linux">
149-
<code class="hljs">$ curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux.gz | gzip -d > cs && chmod +x cs && ./cs setup</code> <br>
150-
</div>
151-
152-
<div style="display:none" id="stepOne-unix">
153-
<p><a href="https://get-coursier.io/docs/cli-installation" target="_blank">手順に従って <code>cs</code> ランチャーをインストール</a>し、その次に以下を実行します。</p>
154-
<p><code>$ ./cs setup</code></p>
155-
</div>
156-
157-
<div style="display:none" id="stepOne-osx">
158-
<div class="highlight">
159-
<code class="hljs">$ brew install coursier/formulas/coursier && cs setup </code> <br>
160-
</div>
161-
<p>または、Homebrewを使用しない場合は</p>
162-
<div class="highlight">
163-
<code class="hljs">$ curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-apple-darwin.gz | gzip -d > cs && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup</code> <br>
164-
</div>
165-
</div>
166-
167-
<div style="display:none" id="stepOne-windows">
168-
<p><a href="https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-win32.zip">the Scala installer for Windows</a>を、ダウンロードして実行してください。</p>
169-
</div>

‎_includes/alt-details.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<div {% if include.id %} id="{{include.id}}" {% endif %} class="alt-details">
2+
<button class="alt-details-toggle">{{include.title}}</button>
3+
<div class="alt-details-detail">
4+
{{include.detail}}
5+
</div>
6+
</div>

‎_includes/code-snippet.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<div class="code-snippet-area">
2+
{% unless include.nocopy %}
3+
<div class="code-snippet-buttons">
4+
<button class="copy-button"><i class="far fa-clone"></i></button>
5+
</div>
6+
{% endunless %}
7+
<pre class="code-snippet-display"><code class="{{include.language}}">{{include.codeSnippet}}</code></pre>
8+
</div>

‎_includes/getting-started.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,29 @@ The Scala installer is a tool named [Coursier](https://get-coursier.io/docs/cli-
2020
It ensures that a JVM and standard Scala tools are installed on your system.
2121
Install it on your system with the following instructions.
2222

23+
{% capture scalaDemo %}$ scala -version
24+
Scala code runner version {{site.scala-3-version}} -- Copyright 2002-2022, LAMP/EPFL{% endcapture %}
25+
2326
<div class="main-download">
24-
<div id="download-step-one">
25-
<p>Follow <a href="https://get-coursier.io/docs/cli-installation.html#native-launcher" target="_blank">the instructions to install the <code>cs</code> launcher</a> then run:</p>
26-
<p><code>$ ./cs setup</code></p>
27+
<div class="recommended-install">
28+
<div class="place-inline">
29+
{% include tabsection.html language='en' id='install-cs-setup-tabs' collection=site.install_tabs %}
30+
</div>
31+
{% capture checkSetupDetail %}
32+
<div class="wrap-inline">
33+
<div class="wrap">
34+
<p>Check your setup with the command <code>scala -version</code>, which should output:</p>
35+
{% include code-snippet.html nocopy=true language='bash' codeSnippet=scalaDemo %}
36+
<p>If that does not work, you may need to log out and log back in (or reboot) in order for the changes to take
37+
effect.
38+
</p>
39+
</div>
2740
</div>
41+
{% endcapture %}
42+
<div class="place-inline">
43+
{% include alt-details.html id='testing-your-setup' title='Testing your setup' detail=checkSetupDetail %}
44+
</div>
45+
</div>
2846
</div>
2947

3048

@@ -165,29 +183,3 @@ Once you've finished the above tutorials, consider checking out:
165183
166184
## Getting Help
167185
There are a multitude of mailing lists and real-time chat rooms in case you want to quickly connect with other Scala users. Check out our [community](https://scala-lang.org/community/) page for a list of these resources, and for where to reach out for help.
168-
169-
<!-- Hidden elements whose content are used to provide OS-specific download instructions.
170-
-- This is handled in `resources/js/functions.js`.
171-
-->
172-
<div style="display:none" id="stepOne-linux">
173-
<code class="hljs">$ curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-linux.gz | gzip -d > cs && chmod +x cs && ./cs setup</code><br>
174-
</div>
175-
176-
<div style="display:none" id="stepOne-unix">
177-
<p>Follow <a href="https://get-coursier.io/docs/cli-installation" target="_blank">the instructions to install the <code>cs</code> launcher</a> then run:</p>
178-
<p><code>$ ./cs setup</code></p>
179-
</div>
180-
181-
<div style="display:none" id="stepOne-osx">
182-
<div class="highlight">
183-
<code class="hljs">$ brew install coursier/formulas/coursier && cs setup </code> <br>
184-
</div>
185-
<p>Alternatively, if you don't use Homebrew</p>
186-
<div class="highlight">
187-
<code class="hljs">$ curl -fL https://github.com/coursier/launchers/raw/master/cs-x86_64-apple-darwin.gz | gzip -d > cs && chmod +x cs && (xattr -d com.apple.quarantine cs || true) && ./cs setup</code> <br>
188-
</div>
189-
</div>
190-
191-
<div style="display:none" id="stepOne-windows">
192-
<p>Download and execute <a href="https://github.com/coursier/launchers/raw/master/cs-x86_64-pc-win32.zip">the Scala installer for Windows</a> based on coursier</p>
193-
</div>

‎_includes/tabsection.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<div {% if include.id %} id="{{include.id}}" {% endif %} class="tabsection">
2+
<ul class="nav-tab">
3+
{% for tabRoot in include.collection %}
4+
{% if tabRoot.language == include.language %}
5+
<li class="item-tab">
6+
<a class="item-tab-link {% if tabRoot.defaultTab %} active{% endif %}"
7+
data-target="{{tabRoot.tabId}}">{{tabRoot.tabLabel}}</a>
8+
</li>
9+
{% endif %}
10+
{% endfor %}
11+
</ul>
12+
{% for tabRoot in include.collection %}
13+
{% if tabRoot.language == include.language %}
14+
<div class="tabcontent {% if tabRoot.defaultTab %}active{% endif %}" data-tab="{{tabRoot.tabId}}">
15+
{{tabRoot.content}}
16+
</div>
17+
{% endif %}
18+
{% endfor %}
19+
</div>

‎_install_tabs/1-macos.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
tabId: osx
3+
tabLabel: macOS
4+
language: en
5+
---
6+
<div class="wrap-inline">
7+
<div class="wrap">
8+
<p>Run the following command in your terminal, following the on-screen instructions:</p>
9+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macOS-brew %}
10+
{% capture homebrewDetail %}
11+
<div class="wrap-narrow">
12+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.macOS-default %}
13+
</div>
14+
{% endcapture %}
15+
{% include alt-details.html
16+
title="Alternatively, if you don't use Homebrew:"
17+
detail=homebrewDetail
18+
%}
19+
</div>
20+
</div>

‎_install_tabs/2-linux.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
tabId: linux
3+
tabLabel: Linux
4+
language: en
5+
---
6+
<div class="wrap-inline">
7+
<div class="wrap">
8+
<p>Run the following command in your terminal, following the on-screen instructions:</p>
9+
{% include code-snippet.html language='bash' codeSnippet=site.data.setup-scala.linux %}
10+
</div>
11+
</div>

0 commit comments

Comments
 (0)