Create documentation for how to run our site with jekyll

[jbubar]

Overview

Sometimes docker does not work, so we should have some documentation about how to use jekyll.

Action Items

• We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Please read How to Contribute to the Wiki
• create a wiki article with the necessary steps
• test it out
• Make sure it is compatible with all systems (Mac, Windows, Iinux)
• share with dev team and have people review it
• close this issue

Plan

• Create a Gemfile.example (Gemfile is in .gitignore. See comments below for discussions about Gemfile and why it can't be checked in)
• create separate markdown on deploying in jekyll. Indicate in the document that if you run into issues, support may be limited and you may be asked to try Docker.
• Link to this file from contributing.md with same caveat as above.

Instruction

• downloading ruby and jekyll for windows
• other instructions for mac
• cd into directory w website repo
• cp Gemfile.example Gemfile
• type bundle install
• type jekyll serve

[jbubar]

@cnk @akibrhast do we need a Gemfile? and also, are there any flags to add to the jekyll serve command that would be useful?

[cnk]

To run Jekyll without Docker, one would need a Gemfile. The problem is, if there is a Gemfile in the repository, it interferers with the built in Gemfile in the Docker container.

Since the important thing is that our code match what GitHub is going to do with our files once pushed, I have been reluctant to do anything other than use the prebuilt, already working, Docker container. If you still want to be able to set up the HackForLA website project not to need Docker, I recommend storing a Gemfile.example in the repo - or in the wiki. That should hide it from GitHub pages. AND make sure you match supported versions of Jekyll. GH pages does not run the latest version of Jekyll - 3.9.0 NOT Jekyll 4. https://pages.github.com/versions/

[Sihemgourou]

@jbubar please add a role label to this and remove the role missing label. Thanks !

[github-actions]

@ Please add update

1. Progress
2. Blockers
3. Availability
4. ETA

[abuna1985]

@jbubar What would you like to discuss about this issue?