Skip to content

DLR-terrabyte/docs

Repository files navigation

Website

This website is built using Docusaurus 2, a modern static website generator.

1. Create the website on your local computer

  1. Install NodeJS and Git

First, you need to install NodeJS and Git on your system.

If you use Visual Studio Code on your own Windows computer, use following commands to install NodeJS:

# install fnm (Fast Node Manager)
winget install Schniz.fnm

# set up environment variables before using fnm
fnm env --use-on-cd | Out-String | Invoke-Expression

# download and install Node.js
fnm use --install-if-missing 20

# verifies right Node.js version in environment (v20.13.1)
node -v 

# verifies right NPM version in environment (10.5.2)
npm -v 

In case of errors during installation of Schniz.fnm just do an update with the command winget update –all.

Install Git with the command winget install --id Git.Git -e --source winget or manually from Standalone Installer with administrative DLR account.

  1. Clone repository

In the terminal, change to the directory in which you want to download the repository and clone it with git clone.

git clone https://gitlab.dlr.de/terrabyte/docs/website

To list all branches and to clone your specific branch, use following commands:

git branch -a

git clone -b <branch> https://gitlab.dlr.de/terrabyte/docs/website

  1. Install docusaurus package

Change to your folder, for example website, and install the docusaurus package.

cd website
npm install
  1. Render own changes

Run your local development server and render the website with your changes:

npm run start

It opens up a browser window with http://localhost:3000. Most changes are reflected live without having to restart the server.

  1. Build static wep page

This command generates static content into the build directory and can be served using any static contents hosting service. This is only necessary for deployment.

npm run build

2. Create the website on the VMs (Test-VM and Live-VM)

  1. Log into LRZ Hopserver

Log into LRZ Hopserver and create public and private keys.

ssh <dlr-account>@lrz-hop-op1.eoc.dlr.de

ssh-keygen

The public key is required to log into the VMs. Just send the public key to Jonas Eberle via mail.

  1. Log into VMs (Test-VM and Live-VM)

It exists both a Test-VM and a Live-VM. First, test all the steps on the Test-VM. If this works fine you can update the website on the Live-VM.

Log into Test-VM via

ssh -i <private-key-file> [email protected]

or into Live-VM via

ssh -i <private-key-file> [email protected]

  1. Create website on VMs

Explanation how to install docusaurus, to build and to publish a static website can be found in the DLR.Wiki. For the creation of the website on the Live-VM, only steps 3 and 4 are necessary.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors 7