Commit 8ca784ee authored by Jonathan Chery's avatar Jonathan Chery
Browse files

Added documentation for week 02

parent eef070cc
Pipeline #227427 passed with stage
in 43 seconds
......@@ -4,9 +4,9 @@ This week I worked on:
- Getting familiar Git, Gitlabs, and some Git commands
- Installing homebrew on my Mac
- Making a website
- Signing the student agreement
- Exploring the Fab website
- Changing/Updating MKDocs
## Getting familiar Git, Gitlabs, and some Git commands
......@@ -19,7 +19,7 @@ Due to my past job experience, I am already familiar with Git. `Git` is a widely
With Gitlab, there wasn't much of a difference from Github, in regards to usage. However, you can learn more about the difference between Gitlab and Github on [GitLab vs GitHub: Key differences & similarities](https://usersnap.com/blog/gitlab-github/). But, here is a snapshot of the difference.
![git_difference](../images/week02/git_difference)
![git_difference](../images/week02/git_difference.png)
In order for me to make a clone of my repo and have it on my local computer, I needed comfirm I had git installed on my computer. To do so, I needed to type the following command in my terminal:
......@@ -35,62 +35,85 @@ The list of commands, git commands, comfirm that git is installed on my Macbook.
After installing Git, I needed to configure my Gitlab by having it associated with my computer. To do so, I generated an SSH key on my Macbook Pro and added the key to my GitLab. To Add an SSH Key correctly, I followed the gitlab tutorial: [Generating a new SSH key pair](https://gitlab.fabcloud.org/help/ssh/README#generating-a-new-ssh-key-pair)
## Installing Hombrew on my Mac
I installed Homebrew on my Macbook. Homebrew is a package manager for macOS. More information about Homebrew, including how to install in for Mac, can be found here: [Homebrew Info](https://brew.sh/)
----
It wasn't too difficult.
Finally, I needed to install Homebrew on my MacBook. Homebrew is a package manager for macOS (or Linux). More information about Homebrew can be found here: [Homebrew Info](https://brew.sh/)
To install Homebrew on Mac was simple. It was a one line code.
But, in short, to install Homebrew on Mac, I opened Mac's terminal and insert the following code into the terminal:
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
After copying and pasting that code into the Terminal, you'll see the magic happen.
To confirm if you have Homebrew, if you type `brew` into the terminal, you should see:
![Magic Is Happening](../images/week02/whoa.jpeg)
![brew](../images/week02/brew.png)
Now, by typing `brew`, I'll get a whole **brew** of commands with some examples:
The image above illustrates all the commands you can do with `brew`.
![brew](../images/week02/brew.png)
## Making a website
To make a website or configure the website that was already up and running, I needed to first decide if I want to create a website from scratch or if I wanted to use a template. I decided to use a template and stay with the following template, [MKDoc](https://mkdoc.org.archived.website/index.html). MKDoc is the default template and it is a free web application software that is easily manageable and deployable, allows you to create and manage online communities, publish materials in multiple language, and many more.
After setting up my environment, it was time to get to work (more work).
However, though I decided to stay with the default, I wanted to make some minor changes within the `mkdocs.yml` to make it my own. To do so, within the `mkdocs.yml` file, I changed:
## Exploring The Tools
I started with Git and Gitlab. I needed to clone my repository on Gitlab onto my computer so I can make the necessary edits such as, but not limited to:
- the site name
- the site description
- the site author
- the copyright
- the site url
- extra
- theme
1. About
2. Agreement
3. Week 01
4. Week 02
5. Final Project
![site_change](../images/week02/site_change.png)
To clone my repository, I ran the following code (Note: I cloned with SSH):
The changes illustrated above allowed to configure my site. After I made the changes within the `mkdocs.yml`, I pushed it onto Gitlab by doing the following commands:
```
git clone git@gitlab.fabcloud.org:academany/fabacademy/2021/labs/dassault/students/jonathan-chery.git
```
`git add mkdocs.yml`
`git commit -m 'Change the site details`
`git push`
The result of the push lead to the below output in the terminal:
![result_of_push](../images/week02/result_of_push.png)
After the changes has ben pushed, I usually have to wait a few minutes before the changes takes effect and is updated on the website.
![result_live](../images/week02/result_live.png)
Now, my changes are live and personal.
**NOTE: To learn and use mkdocs, the mkdocs documentation is extrememly helpful teaching you how to do Markdown language: [mkdocs documentation](https://mkdoc.org.archived.website/docs/howto/text-component/)**
## Signing the Student Agreement
I needed to sign the student agreement before continuing the program. TO access the student agreement, I navigated to the FabAcademy's github and found the student agreement located [here](https://gitlab.fabcloud.org/academany/fabacademy/2021/site/-/blob/master/doc/students.md). I downloaded the agreement:
![downloaded_agreement](../images/week02/downloaded_agreement.png)
read through what was expected of me and signed it. Once I signed my agreement, I uploaded the agreement within my remote folder and placed it directly in the about folder.
![directory](../images/week02/directory.png)
![signed_agreement](../images/week02/signed_agreement.png)
From there, I pushed my local changes onto my Git by doing the following commands in the terminal within my remote directory.
`git add /docs/about/agreement.md`
`git commit -m 'Added my agreement'`
`git push`
The result of my push can be found here: [Student Agreement](http://fabacademy.org/2021/labs/dassault/students/jonathan-chery/about/agreement/)
Running the code cloned my repository onto the location I ran the code in. In this case, I ran the code in my Terminal in the Desktop repository.
**NOTE: Make sure you are in the remote directory. (The directory you cloned from Gitlab)**
![git clone](../images/week02/clone.png)
### Uploading Images in Gitlab.
When it comes to uploading images, what I do is used the Macbook's screenshot functionality. To do so, I do `Shift + Command + 4`. This allows me to choose the size of my screenshot. If the image is still too language, I use an online application that allows me to resize the image such as [Simple Image Resizer](http://www.simpleimageresizer.com/).
Now, I have access to the Gitlab repository on my local computer. That means I can make edits from my local computer and later send my edits to Gitlab to be updated.
## Exploring the Fab website
To do so, I did the following steps:
Finally, I wanted to explore the [FabAcademy's website](https://fabacademy.org/), specifically the content for the [2021 cohort](http://fabacademy.org/2021/). From my exploration, I noted that the important parts of this website for me are:
1. Make edits to your local repository using some Integrated Development Environment(IDE). I used Visual Studio because I already had it installed on my computer and grew to like it.
2. Once your edits is done and you are satisfy, go into your Terminal and `cd` (cd stands for change directory) into the folder your cloned from Git lab.
3. Once you're in the folder, I like runnning the following code `git status`. This ensures me of the status of the folder in git. To get a better understanding of `git status`, read this: [Git Status](https://www.atlassian.com/git/tutorials/inspecting-a-repository)
4. Often times when typing `git status`, you'll get two colors: green and red. The green represents things added and the red represents this removed.
5. Once everything has been comfirmed, I typed `git add .`. This will move every change I did in that folder into a Stage. Stage in Git is like a holding place. You can add and remove edited files from Stage. [More On git add](https://www.atlassian.com/git/tutorials/saving-changes)
6. Next, I did `git commit -m "My updates`. That like of code adds a comment in Gitlab for all to see about what my changes were about. Notice my comment is brief. It's not meant to be long. Short and descriptive, unlike mine, is best and highly recommended. [More On git commit](https://www.atlassian.com/git/tutorials/saving-changes/git-commit)
7. Finally, I did `git push`. This uploads all my changes and comments into my Gitlab. [More on git push](https://www.atlassian.com/git/tutorials/syncing/git-push)
1. [Schedule](http://fabacademy.org/2021/schedule.html) => This is where I can find links to the notes, assignments, and videos
2. [Lab - The current lab I'm working in](http://fabacademy.org/2021/labs/dassault/) => Going back one will display all the labs but, the link added is a link to the Dassault Systemes lab
3. [Fab Academy 2021 Assignments and Assessments](http://fabacademy.org/2021/nueval/) => This is where I find informaiton about what the assignment is for the week and how will it be assessed.
4. [The Fab Academy](http://fabacademy.org/2021/) => This is the main page for the 2021 cohort. This page have a Search Engine where I can search for information or projects from past cohorts.
And, That's All Folks!
Now, my gitlab is updated with the necessary changes for Week 01 and Week 02.
And, behold, [My Website](http://fabacademy.org/2021/labs/dassault/students/jonathan-chery/)
\ No newline at end of file
# Table Of Content
1. [Principles and Practices](../assignments/week01.md)
2. [Project Management](../assignments/week02.md)
\ No newline at end of file
1. [Principles and Practices](http://fabacademy.org/2021/labs/dassault/students/jonathan-chery/assignments/week01/)
2. [Project Management](http://fabacademy.org/2021/labs/dassault/students/jonathan-chery/assignments/week02/)
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment