Merge pull request #440 from VirtusLab/stable

Back port of documentation changes to master

Author: romanowski

.github/workflows/website.yaml

@@ -14,7 +14,7 @@ jobs:
         submodules: true
     - uses: actions/[email protected]
       with:
-        node-version: '12.x'
+        node-version: '16.x'
     - run: .github/scripts/update-website.sh
       env:
         GIT_USER: Virtuslab

gifs/README.md

@@ -12,4 +12,4 @@ Our animated svgs are compose of scenarios built using [demo-magic](https://gith
 2. Edit its content based on included tips.
 3. Run `generate_gifs.sh better-error` to to (re)render svgs based on `better-error.sh` scenario
 
-Gifs will be saved in `website/static/img` and `website/static/img/dark` directories based on name of the scenario (so `foo.sh` becomes `foo.svg`)
+Gifs will be saved in `website/static/img/gifs` and `website/static/img/dark/gifs` directories based on name of the scenario (so `foo.sh` becomes `foo.svg`)

gifs/generate_gifs.sh

@@ -64,6 +64,11 @@ do
     fileName=$(basename "$arg")
     name=${fileName%%.sh} 
 
+    if ! [[ -f "$SCRIPT_DIR/scenarios/$name.sh" ]]; then
+        echo "Scenario $SCRIPT_DIR/scenarios/$name.sh does not exist."
+        exit 1
+    fi
+
     echo processing $name with $TTY_OPS
     svg_render_mappings="-v $SCRIPT_DIR/../website/static/img:/data -v $OUT/.scala:/out"
     svg_render_ops="--in /out/$name.cast --width $columns --height $rows --term iterm2 --padding 20"
@@ -90,7 +95,8 @@ do
         )
       fi
       if [ -z "$no_gifs" ]; then
-        docker run --rm $svg_render_mappings asciinema/asciicast2gif -w $columns -h $rows -t monokai /out/$name.cast /data/gifs/$name.gif || (
+        docker run --rm $svg_render_mappings asciinema/asciicast2gif -w $columns -h $rows -t monokai /out/$name.cast /data/gifs/$name.gif && 
+        docker run --rm $svg_render_mappings asciinema/asciicast2gif -w $columns -h $rows -t solarized-dark /out/$name.cast /data/dark/gifs/$name.gif || (
           echo "Scenario failed: $name" &&
           echo $name >> $OUT/failures.txt &&
           failure=true

website/docs/overview.md

@@ -37,5 +37,5 @@ Scala-CLI documentation is split into three main sections:
 
 **Happy hacking with Scala CLI!**
 
-![Demo](/img/dark/demo.svg)
+![Demo](/img/dark/demo.gif)
 

website/package.json

@@ -14,13 +14,13 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.8",
-    "@docusaurus/preset-classic": "2.0.0-beta.8",
-    "@mdx-js/react": "^1.6.21",
+    "@docusaurus/core": "2.0.0-beta.9",
+    "@docusaurus/preset-classic": "2.0.0-beta.9",
+    "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "docusaurus-plugin-sass": "^0.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
     "react-player": "^2.9.0",
     "sass": "^1.42.1"
   },

website/src/components/features.js

@@ -3,7 +3,7 @@ import React from 'react';
 import ImageBox from '../components/ImageBox';
 
 const featuresList = [
-    <ImageBox image="versions.svg" title="Scala versions, dependencies and JVMs" 
+    <ImageBox image="gifs/versions.gif" title="Scala versions, dependencies and JVMs" 
       key="versions" projects="true"> 
       <p>
         Scala CLI is built on top of coursier
@@ -20,7 +20,7 @@ const featuresList = [
         <i>Some additional setup may be required for <a href="/install#scala-js">JS</a> and <a href="/install#scala-native">Native</a></i>
       </p>
     </ImageBox>,
-    <ImageBox image="universal_tool.svg" title="Universal tool" key="universal" 
+    <ImageBox image="gifs/universal_tool.gif" title="Universal tool" key="universal" 
       projects="true">
       <p>
         If you want to use older <b>version of Scala</b> or
@@ -43,7 +43,7 @@ const featuresList = [
         </p>
     </ImageBox>,
     <ImageBox 
-        image="complete-install.svg" title="Complete installation"
+        image="gifs/complete-install.gif" title="Complete installation"
         key="complete-install" education="true">
           <p>
             Scala CLI comes with batteries included. No additional installation is required, no more fluffing with setting up the correct Java version or <code>PATH</code>
@@ -53,7 +53,7 @@ const featuresList = [
           </p>
       </ImageBox>,
       <ImageBox 
-       image="defaults.svg" title="Solid defaults" 
+       image="gifs/defaults.gif" title="Solid defaults" 
        key="defaults" education="true">
          <p>
            No additional configuration is needed to most Scala CLI commands.
@@ -63,7 +63,7 @@ const featuresList = [
          </p>
      </ImageBox>,
       <ImageBox 
-      image="learning_curve.svg" title="No learning curve" 
+      image="gifs/learning_curve.gif" title="No learning curve" 
       key="curve" education="true">
         <p>
           Scala CLI does not use complex configuration language, its options are simple and self-explanatory
@@ -73,13 +73,13 @@ const featuresList = [
         </p>
     </ImageBox>,
     <ImageBox 
-      image="powerful_scripts.svg" title="Scripts are as powerful as other programs" key="scripts-as-apps" scripting="true">
+      image="gifs/powerful_scripts.gif" title="Scripts are as powerful as other programs" key="scripts-as-apps" scripting="true">
         <p>
           Scripts in Scala CLI can use dependencies and other features as standard Scala programs. Scala CLI is command-line first giving access to all its features without need for any configuration file or specific project structure.
         </p>
     </ImageBox>,
     <ImageBox 
-      image="embeddable_scripts.svg" title="Embeddable Scripts" key="embed-scripts" scripting="true">
+      image="gifs/embeddable_scripts.gif" title="Embeddable Scripts" key="embed-scripts" scripting="true">
         <p>
          Scala CLI can be set up in shebang lines, making your *.scala or *.sc files runnable
         </p>
@@ -100,7 +100,7 @@ const featuresList = [
     // Prototyping
 
     <ImageBox 
-      image="self-contained-examples.svg" title="Self-contained examples" 
+      image="gifs/self-contained-examples.gif" title="Self-contained examples" 
       key="self-contained-examples" prototyping="true">
       <p>
         With Scala CLI, configuration can be included in source code so complex examples can be self-contained and shipped as e.g. gist. Moreover, Scala CLI can compile, run and test gists without any manual work!

website/src/pages/education.js

@@ -7,7 +7,7 @@ const Index = (props) => {
     title="Education with Scala CLI"
     description="Page describing why Scala CLI is good within educational purposes, mainly learning Scala."
     headline="Learn a language not a build tool"
-    image="education.svg"
+    image="gifs/education.gif"
     id="education"
     >
     <p>Scala-cli is deigned in a way so you can focus on learning, not struggle with installation or build tool.</p>

website/src/pages/index.js

@@ -22,7 +22,7 @@ const Index = (props) => {
       <div className="container content">
 
 		{/* Headline */}
-		<YellowBanner title="Scala CLI is a command-line tool to interact with the Scala language." image="demo.svg">
+		<YellowBanner title="Scala CLI is a command-line tool to interact with the Scala language." image="gifs/demo.gif">
 			<p>
 				It lets you compile, run, test, and package your Scala code (and more!)
 			</p>

website/src/pages/projects.js

@@ -7,7 +7,7 @@ const Index = (props) => {
     title="Single-module projects with Scala CLI"
     description="Page describing why Scala CLI is good for maintainig a single-module projects."
     headline="Fight with your bugs not with with you buildtool"
-    image="projects.svg"
+    image="gifs/projects.gif"
     id="projects"
     >
     <p>Scala CLI provides all tools to maintain with easy single module projects like cli apps or single microservice.</p>

website/src/pages/prototyping.js

@@ -7,7 +7,7 @@ const Index = (props) => {
     title="Prototyping, experimenting, reproducing bugs with Scala CLI"
     description="Page describing why Scala CLI is good for prototyping / experimenting / reproducing bugs."
     headline="Move fast and break things but be in control of your build"
-    image="prototyping.svg"
+    image="gifs/prototyping.gif"
     id="prototyping"
     >
     <p>If you ever waste time prototyping, experimenting or reproducing a nasty bug by testing different environment then you intendted?</p>