Ubuntu WSL (Terminal)¶
First of all I need to mention that I’m working on a Windows machine… Which sometimes can be very frustrating… So I decided to install linux on windows using WSL
The project template supplyed by fabacademy is based on mkdocs. Mkdocs is basically the website generator, it is based on python which is both a programming language and a software translating code to computer operation in realtime (It’s called an interpreted language)
Even if this documentation page is hosted on gitlab, it is easier to use a local copy of the project to modify the website. There is several way on running mkdocs locally depending on the platform you’re using.
Get Mkdocs for windows with (WSL)¶
Why WSLThe WSL is a convenient way to take advantage of Linux without setupping a dual boot on your local machine. The WSL is a Windows10 features allowing you to run simultaneously with shared ressources and data (This is not a VM) Using WSL with Visual studio code is a pretty convenient way to maximize your productivity if you need both Linux and Windows.
To get Ubuntu and Windows working together follow these steps :
- In windows startmenu type “feature” to launch the windows feature manager
- Select the Windows subsystem linux & click apply (You may need admin sessions)
- Open Microsoft store and install Ubuntu (Restart may be required)
- Start Ubuntu and create your login and password
Alternatively you can type this command in powershell
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
MkDocs requires a recent version of Python and the Python package manager: pip, to be installed on your system.
You can check if you already have python installed from these command line:
$ python --version Python 3.8.2 $ pip --version pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8) If you already have those packages installed, you may skip down to Installing MkDocs.
If Python isn’t installed Start Ubuntu and do the following :
You can start the linux subsystem in any terminal using :
- Udpate package list using :
sudo apt-get update -y && sudo apt-get upgrade -y
Install Python using :
sudo apt-get install python3.8
Install all the required package using :
pip install -r requirements.txt
This should be run from inside your repository…
This will install mkdocs and any other package required.
Most of the time pip is installed with python but you can install it using
sudo apt install python3-pip
To install Git simply type :
sudo apt-get install git
Using SSH authentification¶
When working on documentation I must login to gitlab very often (each time I want to bring my changes online). It is possible to use git only using standard passwors / login methods… or you can use SSH !
Ssh-key security is a very good way to authentify everywhere. ssh-key are based on asymetric cryptography protocol. Which mean that when you generate a key, the program gives you a public key which can be shared with every one, and a private one which shouldn’t. When a website want to check you’re identity it can send a bunch of data encrypted using your public key, then to decrypt the data, the private key is needed, in theory only you’re computer should be able to decrypt the data and autentify.
Open a terminal and type :
Copy the whole content on this file and add it to your gitlab account. Go to your settings > SSH key and paste the content of the key.
Then you should be able to git clone, git commit, git push without typing your password ! Seems obvious but don’t share your private key to anyone !
Clonning a repository¶
To clone my repo, I used this command :
$ git clone email@example.com:academany/fabacademy/2021/labs/lamachinerie/students/jules-topart.git
Cloning into 'jules-topart'... remote: Enumerating objects: 150, done. remote: Counting objects: 100% (150/150), done. remote: Compressing objects: 100% (113/113), done. remote: Total 1044 (delta 65), reused 96 (delta 35), pack-reused 894 Receiving objects: 100% (1044/1044), 40.77 MiB | 4.46 MiB/s, done. Resolving deltas: 100% (456/456), done.
This will create a floder contaning all your documentation site. Browse wisely before running the command.
The git clone command can be use trough ssh or https depending on the URL you use. I cloned over SSH howerver the port 22 in sometimes blocked in university. You can use https as well but your password will be asked… (You can use port 443 instead or port 22 using the alternative ssh port of Gitlab)
When you’ve clonned the repo, use
mkdocs serve to start the local server.
your site should be accessible on 127.0.0.1:8000
If the command didn’t worked for you, try this :
python -m mkdocs serve
If this one does the job, pip installed mkdocs in a folder which isn’t in your path.
%appdata%/Python/Python39/Scripts to your path. The previous command should work.
When your docs is updated and you’re ready to post, use
git add --all
to add your changes to the next commit, then use
git commit -m "Your commit message"
Note : I personnaly use the commit convention from here to name my commits.
When you’re ready to send your changes (and absolutely sure of what your doing)
git push to send everything to your gitlab page.
The page should build and after a few moment be updated !
Visual Studio code¶
Just one more thing. I’m using visual studio code to write, code, git my documentation. If you don’t already know this great tools check this link
VSCode offer the ability to install a lot of additionnal package from Text editing tool to IoT flashing tools
I like It !. This page was written using vscode ;)
Running the website¶
To start the local webserver run this command from the project root: