Feedback Week 1 and Week 2
Principles and Practice Feedback
Comments
Final project website
- Good description of the project
- As Neil always says: Use the Final project page as a diary. Try to write something there each week, explaining how each week's assignment has contributed to your final project.
From Assessment guide
-
Sketched your final project idea/s -
Described what it will do and who will use it
Project Management
Comments
All in all, VERY GOOD DOCUMENTATION. Still minor things to improve:
About me website
- It is OK.
Please, add some contact information / linkedin / university page. Just in case someone would like to contact you.
Description of the website
- Very good description!!!
Please, mention how you modified the .yml file.- Would be nice that you include your file structure and a short schema of your layout (where is the menu and so on)
Description of the GIT process
- Good description!! However, few mistakes:
You say:
After cloning the respository, I customised the YAML configuration file for MkDocs (mkdocs.yml) in my local repository. This file has the details for site name and other settings and then synchronised the changes with the remote repository using git pull origin master
This is wrong. I guess what you did is modify your remote repository using the Fabcloud web interface and then you synchronize with your local server using git pull
.
You forgot to include the commandgit add
to move the files from the working directory to the stage area.
Other comments
- Your root page has a symbol that is not shown correctly before the image: "*it all in with a *"
In the Project Management description one of the links has not compile correctly:[MkDocs] (https://www.mkdocs.org)
From Assessment guide
-
Made a website and described how you did it -
Introduced yourself -
Documented steps for uploading files to archive -
Pushed to the class archive -
Signed and uploaded Student Agreement