Merge pull request #283 from Exabyte-io/chore/relocate-platform-acces…

…s-tutorial

chore: relocate platform access tutorial

lang/en/docs/tutorials/formation-energy.md

@@ -1,3 +1,5 @@
+<!-- As of 2024-10-17, this tutorial is unused -->
+
 # Formation Energy - VASP
 
 This page explains how to calculate formation energy[^1] based on density

lang/en/docs/tutorials/overview.md

@@ -1,15 +1,10 @@
 # Tutorials
 
-Below we present a short video on various ways of accessing Mat3ra platform.
 The sub-pages under this section contain detailed tutorials. You can find
 specific tutorial from the index below or locate the corresponding entry in the
 sidebar navigation.
 
-<div class="video-wrapper">
-<iframe class="gifffer" width="100%" height="100%" src="https://www.youtube.com/embed/vERldqp77bU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
-</div>
-
-## Index of Tutorials
+## Table of Contents
 <!-- this index is generated using scripts/generate_index_of_sub_section.py -->
 - [Overview](overview.md)
 - Jobs via Command Line
@@ -67,6 +62,7 @@ sidebar navigation.
         - [k-point convergence](dft/addons/kpt-convergence.md)
         - [Structural Relaxation](dft/addons/structural-relaxation.md)
 - General Functionality
+    - [Accessing the Platform](platform-access.md)
     - [Jupyter Notebook](other/jupyter.md)
     - [Restart from Previous Job](other/restart-job.md)
     - [Upload External Job Data](other/external-upload.md)

lang/en/docs/tutorials/platform-access.md

@@ -0,0 +1,24 @@
+# Accessing the Platform
+
+There are three main modes of accessing the Mat3ra platform: 
+
+- (1) Web/browser interface 
+- (2) [Command line interface](../cli/overview.md) (CLI), and 
+- (3) [REST API](../rest-api).
+
+- Below we present a short video demonstrating various ways of accessing the Mat3ra platform. It covers:
+
+- 00:54 Web platform overview
+- 01:42 Materials designer
+- 02:26 Command Line Interface 
+- 02:57 SSH to login node
+- 04:01 Web terminal
+- 04:13 API access
+- 04:37 API access from Jupyter Notebook
+
+
+## The Video
+
+<div class="video-wrapper">
+<iframe class="gifffer" width="100%" height="100%" src="https://www.youtube.com/embed/vERldqp77bU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+</div>

mkdocs.yml

@@ -194,6 +194,7 @@ nav:
                 - k-point convergence:                   tutorials/dft/addons/kpt-convergence.md
                 - Structural Relaxation:                 tutorials/dft/addons/structural-relaxation.md
         - General Functionality:
+            - Accessing the Platform:                tutorials/platform-access.md
             - Jupyter Notebook:                      tutorials/other/jupyter.md
             - Restart from Previous Job:             tutorials/other/restart-job.md
             - Upload External Job Data:              tutorials/other/external-upload.md

scripts/netlify-build.sh

@@ -1,3 +1,4 @@
+#!/bin/bash
 git submodule update --recursive --init
 git lfs install
 git lfs pull
@@ -7,4 +8,4 @@ git lfs pull
 
 # pip packages are automatically installed by netlify
 # if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-mkdocs build
+python -m mkdocs build