Prerequisites:

Git installation on your computer

Linux based systems : 

sudo apt install git

Windows Based systems : git

Git Hub personnal account Create a personnal account on git hub if you don't have one.

If you want to edit files on the Quantum Optics documentation you need to be invited by an owner.

Download VSCode

Step 1 : clone the github repository on your own workspace

Copy the repository github on your clipboard.

On the VSCode GUI click on the github icon (second item in the top left corner) and then click on Clone Repository and paste the link you just copied.

Now you should see all the files of the team on your VSCode interface on the left part of the screen.

Step 2 : create/modify a documentation file and add it to the doclkb page

Go on the repository you cloned on Step 1 and create a file "myfilename.md" (.md stands for the markdown language in which the documents of this page are written) or go on the document you want to modify.

Write the content using markdown. If you want to have a graphical overview of what your modified file would look like you can download node (at least node v14) and then run a local server from the VSCode terminal :

sudo apt install nodejs npm

For macOS users, if apt doesn't work, you can install homebrew and run instead:

brew install nodejs 
brew install npm

After having installed npm and nodejs, install all required packages in the package.json file at the root :

sudo npm install

Do not run sudo npm audit fix --force ! It tends to break your install !
In the working directory type the command line :

npm run dev

Once you're done with modifications you can commit the changes you made on the github repository of the team : -Click on the github icon -Enter the message that goes with your commitment (for instance "first commit username)"). -Click on commit next to SOURCE CONTROL title.

If it's the first time you use VSCode with your github account it may ask you to configure your git user.name and user.email. The following command lines should work for any OS :

git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "MY_NAME@example.com"

The user.name and the user.email don't have to be identical to the user name and the email you used te create your github account.

If your commit was succesful, you should be able to see your file appear on the Github page of the team as well as on the doclkb page.