1. Principles and practices & Project Management¶
This week I worked on defining my final project idea and started to getting used to the documentation process.The documentation process, involves the use of GITLab in tandem with Git Bash (which I installed) as well as Brackets (of which I also installed), to share my learning process via a website. As a Standard Windows user, using Git prove to be difficult at first. After many attempts, I felt as though the GIT Bash application was not being a team player.
Research/ Procedure/ Process¶
Project Management¶
Alas, I can say that this final attempt has proven successful! After going through the GIT tutorials provided, in addition to, the GIT Cheat sheet, and encountering some unexpected errors, I was finally able to get my repository up and running. Thus far, this has been a challenging learning curve for me, to familiarize and grasp the various concepts of GIT.
So firstly, I had to setup my user name and email respectively, using: git config –-global user.name “marvin-holloway”
To configure my email address for uploading git config -–global user.email “marvin.holloway@niherst.gov.tt”_
As a “noob” using GIT I had to generate my SSH key ssh-keygen -t rsa -C “marvin.holloway@niherst.gov.tt”
For my keygen check cat ~/.ssh/id_rsa.pub
Upon the generation of my ssh key, I copied it across to the GitHub Fabcloud, and placed it within its appropriate designation. However, I was very mindful not to paste my private key, but my public key only, as I didn’t want to risk revealing my identity globally.
A recommendation was made to create a desktop folder that would house the contents of my repository, locally, so I can edit, modify, test and vet prior to online uploading to my website.
In order to access this, I went into GIT Bash and typed
cd desktop cd folder name
I then went to my GitLab page and clicked clone and copied the url
git clone and pasted the link and clicked enter.
This is the process I used to set up a copy of my repository locally.
In addition to this, I also learned how to
Commit a GIT (for my sketch, student agreement, about picture, etc)
git commit -m “final project sketch”
as well as Push a GIT (this means placing it to the online website)
git push
One thing to note is that I should ever so often, check my git status to ensure everything is in working order. to do this
git status
Editing the WEBSITE¶
To achieve this, I used the Brackets software. This software utilises the “Markdown” language to edit text, images, code, videos, links, etc.
Here is an example of the Brackets interface, as it uses markdown
In the image below, you can see a more detailed layout of the brackets interface. Each coloured square indicates a different pane specific for editing, previewing, etc.
- Yellow indicates the workspace area, most if not all my editing was done here
- Red indicates the repository content. It also allowed me to select which “week” I would be working on at that poiunt in time
- Blue is a pretty nifty tool as it allowed me to “preview” the conent in a live format. Ergo, it allowed me to have an accurate idea of the appearance of my website. It can be selected by clicking th icon indicated by the green arrow.
Once I was satisfied with the content I edited, I then merged the corresponding files to the GIT directory. I utilised the following commands to accomplish this:
cd ~/desktop/FABACADEMY22/marvin-holloway
(to achieve master control)
git status
(to see what has to be added)
git add .
(to add the files)
git commit -m “description of what is commited”
(to track what has been committed)
git push
(to push the data to the website)
Success! The edited files went up as expected.
Useful programs¶
Principles and Practices¶
Assignment
- Plan and sketch a potential final project
Please refer to the following link Final Project for the Final Project Plan and Sketch.