2. Project management¶

I began exploring how to use and edit my site. Through many failures, I am beginning to learn how to use markdown and GitHub.

Research¶

To begin, I copied the Student Agreement into the site, and wrote my name in at the bottom.

Then, I began adding info to my ‘About Me’ page by sharing some info on my background in STEM and my interests. Although it is not fully completed, I thought it would be nice to start out by letting the Fab World know a bit about me.

I searched for ‘mkdocs themes’ on Google and found a page that showcased a wide variety of themes that were compatible with GitHub. I wanted to customize my page a bit and add some of my own personality to it, so I chose the one I liked the best, which was Simplex, and attempted to add it to my site.

I also searched for provided colors on the site and found these. ‘Deep Purple’ really caught my eye and will most likely be the shade I will use in the future.

From there, I went into the ‘requirements.txt’ section under the ‘WEBIDE’ and added another line, entering ‘mkdocs-simplex’ to change the theme. Then, I clicked ‘commit.’

Inputting the name of the theme, simplex, next to ‘name:’, I was under the false impression that it would pass through the pipeline, and I would not have to think twice about the theme any longer. That was not the case.

Every edit I had made either failed or was cancelled aside from my entries into my ‘About Me’ page.

The issue turned out to be that I had entered the ‘Simplex’ theme wrong and that it was not accepting it. Eventually, I decided that I did not like the ‘Simplex’ theme as much as I thought I did, so I got rid of it as a whole. I accidentally left the ‘mkdocs-simplex’ under the ‘requirements.txt’ which led to every commit that I made failing. In extreme confusion,I had checked all the possible places for mistakes to slip through. I did not have any images on my site at the time, so that was not it. I did not add a new branch – I was uploading to the master branch everytime – so that also was not it. After checking the pipeline and trying to push my past commits about 5x, I randomly checked the ‘requirements.txt’ page as a last resort. Sure enough, the problem was there.

Conclusion¶

I learned a lot about how GitHub functions and about markdown. I was able to troubleshoot and find out why none of my commits were going through.