Skip to content

1. Project Management

This week I worked on setting up my GitLab for documentation of my Fab Academy Experience

Documentation Setup

  1. GitLab Setup

    1. Completed all four tasks from the Fab Academy welcome email

    2. Reviewed David Taylor and Teddy Warner’s GitHub presentation

    3. Reviewed Barbara Morrow’s project management documentation

    4. Reviewed Chloe Laurent’s project management documentation

    5. Review Adam Harris’s notes on non-terminal Git setup

    6. Generated SSH key Type ED25519 with Windows native terminal run in administrator mode

      1. ssh-keygen -t ed25519 -C “Zack’s-SSH-Key”
      2. SSHKey
      3. SSHKey Added

    7. Download Git for Windows 2.39.1 using link from Adam Harris’s notes.

    8. Installed Git for Widows

      1. Useful app seems to be Git Gui.

    9. Having trouble verifying pip is installed with Python

    10. Uninstalling Python 3.11 and will try reinstalling making sure pip is selected

      1. Reinstall successful

      2. Python Success

    11. Opened Visual Studio Code

      1. Selected Clone repository and copied the https: URL to the dialog box that opened.

      2. Repository was successfully cloned…I think

    12. Git is not working in VS Code Studio, but works in Command Prompt

      1. Added Git path to environmental variables in Windows with help from Adam Durette

      2. EnvironmentalVariable Path

        1. Still not working in VS Code. Not sure why, so let’s try a reboot.

        2. Restarting computer solved the problem in VS Code

  2. MK Docs Setup

    1. First Question, is this a need to have or a nice to have.

    2. May stick with HTML editor for now.

    3. Mr. Dubick would like use to stretch ourselves and use different software than we are familiar with, so I will install MKDocs and learn how to use it.

    4. Verified Python and pip are correctly installed used commands in MKDocs documentation VS Code Powershell.

    5. Ran “pip install mkdocs-material” successfully

    6. Ran “pip3 install mkdocs-git-revision-date-localized-plugin” successfully

    7. Tried “mkdocs serve”

      1. returned “Error: Config file ‘mkdocs.yml’ does not exist.”

    8. Reran “pip install mkdocs-material” in case something didn’t install correctly.

      1. Returned that “Requirement already satisfied:” for a whole list of items, so I’ll assume it’s installed correctly

    9. Reviewed Aaron Logan’s Project Management Documentation about MKDocs and see that he had a similar issue with MKDocs –serve.

    10. I downloaded and copied the Student Master Template to my “Zack-Budzichowski” folder that contained my repository and think I may have made a mistake.

    11. Mistake made by merging the MKDocs template with the previous HTML student template. Rather than undoing everything I deleted the local repo and installed the MKDocs FabAcademy template.

      1. Now I’m having trouble syncing the two different templates.
      2. My solution turned out to be deleting the template on my local repo and replacing it with the brand new MKDocs Student template and then pushing the local repo up to GitLab to replace the server repo.
      3. The ciritical piece for this part was making sure the ‘mkdocs.yml’ file was located in the ‘Zack-Budzichowski’ directory along with the ‘.gitlab-ci.yml’ file. VSCode yml

    12. It all seems to be working correctly now and I’ve begun to the construction of my Fab Academy site. Like any software, there is a learning curve, but it doesn’t seem too steep.

  3. Visual Studio Code

    1. Added LiveServer extension to test our webpage changes. Recommended by Stuart
      1. Works well for HTML

    2. One issue with the Live Server is that it only appears to work with HTML and not MKDocs. To test local repository with MKDocs I need to use the “MKDocs serve” command

      1. Now that I have MKDocs up and running, I have decided to shelved Liver Server for now and use MKDocs Serve exclusively to test out changes to my site.

    3. My key to using VSCode is to understand how to navigate the ‘EXPLORER’ pane on the left side

  4. Learning

    1. For Windows 10, when terminal is referenced, use PowerShell terminal
    2. Git and “Git for Windows“ seem to be different programs
      1. I wasn’t able to clone my GitLab repository with “Git” installed.
      2. I uninstalled “Git” and installed “Git for Windows” in its place and it worked. Not sure why.
    3. When commands should work but don’t try restarting the computer to reset and update the paths.
    4. Patience is a virtue. It was surprising how many items seemed to fix themselves when I slowed down and gave the computer, VS Code or GitLab time to finish processing my last request.

Potential Final Project

ZackProject

Project Sketch

A description of the project is under my Projects tab.