Open-Hardware-Leaders / ohlwebsite

Repository hosting website source files for the Open Hardware Leaders program
https://openhardware4.me
GNU General Public License v3.0
5 stars 3 forks source link

About easy publishing and static site generator selection #1

Closed jurra closed 4 years ago

jurra commented 4 years ago

Hi Everyone, as there has been some difficulties and legit pains with updating the website in Github, I took some time to explain the problems that cause them.

  1. The issue with updating the website is not related to the selection of Vuepress or whatever static site generation. The gitlab instance we had worked perfectly because the continuos integration is easier in Gitlab.

  2. I tried Github with Actions for continuous integration but it didn't work. So I did how the github web page hosting has been used normally. You basically build the website from the src generating html, and css and running the index.html from gh-pages branch. The main issue I faced was related to changing the remotes and some reference issues with the branch. To solve this I basically had to make a completely new branch and rebase.

  3. About the selection of the static site generator: There are several reasons why I started using vuepress:

    • Vuepress it is meant for documentation and it has great integration with markdown,
    • Vuepress is powered by Vue (a very user friendly and powerful javascript framework), which allows to build easily new functionality and customization.
    • I happen to use Vuepress and have a background on Vue so that helps in maintaining the website.
    • There are indeed other options, including Hugo which looks great, but you have to peek an option, I don't know GO, which I could learn, neither React, so for the sake of pragmatism I stayed with Vuepress.

👉 For more info on static site generators and how Vuepress is ranked check here a table of comparisons.

Please let me know what issues you encounter in the following:

  1. Deploying locally
  2. Pushing with the deploy shell
jurra commented 4 years ago

I am closing this issue, automatic deployment after pushing change to master is working