Project Management feedback
Principles and Practice Feedback
From Assessment guide
-
Read the Fab Charter -
Sketched your final project idea/s -
Described what it will do and who will use it
Comments
About your website
It is OK. You have used default template, but you have customized it.
Final project website
- Please, explain in more details your final project idea in the Principles and Practices section. It does not matter that you are modifying later the project, but you should have at least one or two ideas (I changed my project at least 3 times during my Fab Academy). You should describe what it will do and who will use it.
- 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. For instance, you can provide a short description of your project, and then link to the the Principles and Practices section which develops further the idea.
- While you update the weekly assignments, include a short description on how each deadline has contributed to the final project. Add a link to that assignment, showing more detailed information.
Other comments
Project Management
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
Comments
About me website
OK. Perhaps, you may want to provide some contact information. You can use the social media links in the footer.
Description of the GIT process
- Explain a bit what you got out of the tutorials.
- Present the command to generate the public/private key pair. Explain why you need to generate this key-pair
- Some clarification:
- You do not have to do a
git pull
after cloning it.git pull
downloads the changes of the remote repository which are not yet in the local repository + updates the working space. -
git status
does not really shows the difference with last pull, but it presents the state of the different files: no changed, modified or in stage area ready to be committed. IN addition, it provides information on the current branch and if it is sychronized with remote server. -
git add
does NOT add files to local repository. It simply mark the files as ready to be committed. They move the files to the stage area. All files in the stage area will be included in the next commit. -
git add .
andgit add --all
are slightly different: see https://stackoverflow.com/questions/23003118/any-difference-between-git-add-and-git-add-all - Explain the role of the
gitlab-ci.yml
file
- You do not have to do a
Description of the website
- You can use react. First React is a javascript library (not Java). The only thing is that if you have to generate dynamic code (compile something with Node.js, for instance, you need to execute it locally. You cannot render the page on the server side (actually, I think you can, but you need to configure properly the gitlab-ci.yml). So, React can be used if: you only use Javascript library for the client OR if you want to render dynamically a website you do it locally and then upload the result.
- Explain briefly what is a website static generator and what is mkdocs
- Please, clarify what is the role of the mkdocs.yml file you have modified.
- Could you mention which is the theme you are using in MKdocs.
- Actually, you can have any available template for MKDocs. The only condition is that you modify the
gitlab-ci.yml
and therequirements.txt
properly.
Other comments
- In the SSH key generation section the image: https://fabacademy.org/2021/labs/oulu/students/kenichi-komatsu/images/week01/gitssh.png is not shown.
- Typos:
- lunix -> linux
- relfrections -> reflecitons
- capticals -> capitals
- When you use commands in your text, I would strongly recommend use proper formatting. It will make your text easy to read: https://docs.gitlab.com/ee/user/markdown.html#code-spans-and-blocks