|
|
|
|
|
This tutorial will show you how to edit the content of this website under Microsoft Windows.
|
|
|
|
|
|
## Step 1: Authentification
|
|
|
|
|
|
You first need to make you recognized by the system: authentication is based on a private key,
|
|
|
which must stay "hidden" on your computer, and on a public key, which you may give to others.
|
|
|
|
|
|
In order to generate these keys, you must download and install the "Putty" software and follow
|
|
|
this tutorial:
|
|
|
|
|
|
[https://help.cloudforge.com/hc/en-us/articles/215243143-Configure-TortoiseGIT-client-to-work-with-SSH-keys-on-Windows](https://help.cloudforge.com/hc/en-us/articles/215243143-Configure-TortoiseGIT-client-to-work-with-SSH-keys-on-Windows)
|
|
|
|
|
|
**IMPORTANT**: in the above tutorial, stop just before step E: you are *not* going to use app.cloudforge.com at all, but rather
|
|
|
gitlab.inria.fr. Once you have done sted D, then proceeds to "Step 2: gitlab account"
|
|
|
|
|
|
## Step 2: Gitlab account
|
|
|
|
|
|
Point your browser to this server:
|
|
|
|
|
|
[https://gitlab.inria.fr](https://gitlab.inria.fr)
|
|
|
|
|
|
and click on "register" to create a new account.
|
|
|
When your account is created, you go to your **settings** close to your **profile** menu, and look on the left for the menu **SSH Keys**.
|
|
|
There, you can "add" the public SSH key that you have created on step 1: just copy-paste your public key in an editable text box on the right
|
|
|
give it a Title and click **Add key**.
|
|
|
|
|
|
You are now recognized by gitlab.inria: let me (Christophe Cerisara) know of your login name, and I will add you as an editor of the website.
|
|
|
|
|
|
## Step 3: Install Tortoise Git
|
|
|
|
|
|
In order to "download" (or *pull* in the GIT terminology) the source of the website onto your computer, and later on
|
|
|
"upload" (or *commit* and *push*) your modifications into the server, you will use the **Tortoise GIT** software.
|
|
|
|
|
|
Just go to [https://tortoisegit.org/](https://tortoisegit.org/) and follows the instructions to install tortoise git.
|
|
|
|
|
|
Once this is done, you should let tortoise GIT know about your SSH keys: just jump back at the end of the tutorial in Step 1,
|
|
|
and complete the process under the section **Using SSH keys with TortoiseGit client**
|
|
|
|
|
|
You are all setup to start editing the website !
|
|
|
|
|
|
## Step 4: Get an initial copy of the website source code
|
|
|
|
|
|
You must first download the complete source code of the website: you must do this operation only once !
|
|
|
Because later on you will just update your local copy of the website to include the other people updates
|
|
|
via a "git pull" operation, without downloading again the whole site structure.
|
|
|
|
|
|
This is done via a "git clone" operation within tortoise GIT, where you should give the server url:
|
|
|
|
|
|
```
|
|
|
git+ssh://git@gitlab.inria.fr:cerisara/olkisite.git
|
|
|
```
|
|
|
|
|
|
You may want to read a bit some documentation about tortoise git to get familiar with this software.
|
|
|
|
|
|
## Step 5: Edit your local copy of the website
|
|
|
|
|
|
You should now see in your computer directory, the website repositories: look for the directory **content**,
|
|
|
which contains the textual content of the web pages.
|
|
|
|
|
|
- In the directory **content/portfolio**, you'll find a list of files, each file correspond to one of the "latest works" pages that appears
|
|
|
on the front page of the site. If you want to add a new work, just copy one of these files, edit the newly copied file and save it.
|
|
|
Edition of a page must be done with a simple text editor: I recommend "Word Pad" (and **not** Microsoft Word, which is not done to edit pure
|
|
|
text files). Open the file with WordPad, and just look: the structure of the file should be quite straightfoward, with a header on top that
|
|
|
contains some metadata (date of publication, image to be shown, title...) followed by a textual description. You can see that title lines are
|
|
|
preceded by **###**, otherwise, it's just plain text. If you want to learn more about how to do some special formatting within these text files,
|
|
|
just search on the internet for "Markdown tutorial", and you will get all explanations and details about this edition format.
|
|
|
- In the directory **content/blog**, you'll find a list of files that correspond to the blog posts
|
|
|
|
|
|
When you add a new file, you should let GIT know that this new file should be included in the site: you must then perform the **git add**
|
|
|
operation on this file (see tortoise git documentation).
|
|
|
|
|
|
## Step 6: Commit your modifications onto the server
|
|
|
|
|
|
When you are done editing the site, you must perform the **git commit** and **git push** operations to send your modifications onto the server.
|
|
|
If no error is shown, then the files have been correctly sent to the server.
|
|
|
If an error occurs, it is likely to be because of a **conflict**, i.e., someone else has modified the site before you:
|
|
|
you must then do a **git pull** operation to get your local copy up-to-date, and then again try the commit and push operations.
|
|
|
It may happen (but rarely) that the git pull also fails, which is because you have edited the very same file than someone else;
|
|
|
the just let me know, and I'll show you how to solve such conflicts.
|
|
|
|
|
|
But in most cases, everything should go well and after a few minutes, the new version of the website should be automatically visible. |
|
|
\ No newline at end of file |