Week 1 : Website and Documentation

25th Sep, 2018
image1

Documentation is a very important element for storing and sharing as you go. It can help others understand the process , mistakes and success of any particular work. Therefore, I have documented how i made my website platform to do further documentation

"This week our lab did lottery system to determine who will make what kind of website , one version with more precise and more features or one with details but simple features, I got the second one :P, the purpose behind this was to help students understand two versions of website development"

Nishtha Kaushik

Reffered Links

Steps

  • Step 1: Hands on with Markdown on website

    I started by signing in and updating my website directly through git but then i had issue resizing my images as well as i was curious to apply skills learnt before on website development and started searching templates for the same.
    Download Git bash from the referred links above. Follow the steps mentioned in the video link above to setup Git. Git installation is not about next next options so be carefull whatare you selecting and pressing.









  • Step 2: Get your SSh key

    Below are the steps to generate SSh key which should be completely kept confidential and pasted to your git account-settings-SSh key.

    GENERATING SSH KEY
    
ziosm@ElitebookxpsMediaCenter MINGW64 ~
$ ssh-keygen -t rsa -C "nishtha93.k@gmail.com" -b 4096
Generating public/private rsa key pair.
Enter file in which to save the key (/c/Users/ziosm/.ssh/id_rsa):
Created directory '/c/Users/ziosm/.ssh'.
Enter passphrase (empty for no passphrase):
Enter same passphrase again:
Your identification has been saved in /c/Users/ziosm/.ssh/id_rsa.
Your public key has been saved in /c/Users/ziosm/.ssh/id_rsa.pub.
The key fingerprint is:
Code was here(hidden)
The key's randomart image is:
+---[RSA XXXX]----+
|            o    |
|           o .   |
|          . o E  |
|      .. +   o   |
|     . oS + o .  |
|      oo.o oo+ o.|
|      .o.  +oo+++|
|       +o+ .++o++|
|      oo*+o+*+oo%|
+----[XXXXXX]-----+

ziosm@ElitebookxpsMediaCenter MINGW64 ~
$ cat ~/.ssh/id_rsa.pub | clip
ziosm@ElitebookxpsMediaCenter MINGW64 ~
$ git clone git@gitlab.fabcloud.org:academany/fabricademy/2019/students/nishtha.git
Cloning into 'nishtha'...
The authenticity of host 'gitlab.fabcloud.org (13.59.248.79)' can't be established.
ECDSA key fingerprint is xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added 'gitlab.fabcloud.org,13.59.248.79' (ECDSA) to the list of known hosts.
Enter passphrase for key '/c/Users/ziosm/.ssh/id_rsa':
remote: Counting objects: 114, done.
remote: Compressing objects: 100% (47/47), done.
remote: Total 114 (delta 60), reused 114 (delta 60)
Receiving objects: 100% (114/114), 400.75 KiB | 241.00 KiB/s, done.
Resolving deltas: 100% (60/60), done.

ziosm@ElitebookxpsMediaCenter MINGW64 ~










  • Step 3: Prepare your Website

    Now download Templates from the referred links above and also download brackets or Visual studio code to edit your html files for documentation



    • After exploring this template, i realised the options are less, so switched to different template and mixed different elements from different websites. Mahavir and I decided to compile different elements from more than 10-15 websites and designed this as per our own taste but with common basic design which we can use to show our students later,my choice is to go for something detailed like this.



  • Step 4: Ready to update your GIT

    After setting up git , you now following code below , you can add updates and push which will reflect on your git account as well as on your other domain, Finally i selected one template which we used as Zios template 

    Pull-update-Push
    
ziosm@ElitebookxpsMediaCenter MINGW64 ~/nishtha (master)
$ git push
Enter passphrase for key '/c/Users/ziosm/.ssh/id_rsa':
Everything up-to-date

ziosm@ElitebookxpsMediaCenter MINGW64 ~/nishtha (master)
$ git pull
Enter passphrase for key '/c/Users/ziosm/.ssh/id_rsa':
Already up to date.


        "ADD YOUR UPDATES TO THE GIT FOLDER CREATED ON YOUR PC"

ziosm@ElitebookxpsMediaCenter MINGW64 ~/nishtha (master)
$ git add --all

ziosm@ElitebookxpsMediaCenter MINGW64 ~/nishtha (master)
$ git commit -m "added requirements.txt back"
[master 33a7049] added requirements.txt back
 1 file changed, 2 insertions(+)
 create mode 100644 requirements.txt

ziosm@ElitebookxpsMediaCenter MINGW64 ~/nishtha (master)
$ git push
Enter passphrase for key '/c/Users/ziosm/.ssh/id_rsa':
Enumerating objects: 4, done.
Counting objects: 100% (4/4), done.
Delta compression using up to 4 threads
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 306 bytes | 306.00 KiB/s, done.
Total 3 (delta 1), reused 1 (delta 0)
To gitlab.fabcloud.org:academany/fabricademy/2019/students/nishtha.git
   527045c..33a7049  master -> master

        "ITS DONE"


FINAL PROJECT

I didnt come up with a final idea that i would like to pursue as my final project. Ideas varied from concepts like Mouth muff to smart heels , from thermal table mats to beard kits, I would like to pursue a final project which is different as well as at a relatively has an advantage than others in terms of exports, not only with the purpose to to sell but also which considers the art and design created in India for the world. Therefore, Im still running an Export analysis for my firm and the products. This is the time I would like to produce something which is more than a prototype.

Few Inspiring videos can be found below

What to use

Documenting through markdown is simple and fun to do but if you want to get into documention with design elements than html is great and easy to start with. 
I started with visual studio but moved on to brackets as I find it well organised and quicker.

Ill do my documentation later

Documentation is a way of recording all your mistakes and successful attemps and very useful to refer it back, it is helpful only if done simultaneously not later. 
git pull > git add --all > git commit -m "message" > git push

Warning Panel

Dont share your SS key screenshot or code anywhere in your documentation.