Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Convert resources into static site #5
Hi all, for reference, this PR seeks to address issue #3. I wanted to start from an existing template to minimize the amount of work going into this issue and unfortunately, it seems that Jekyll templates are often proprietary. Instead, I decided to use a similar static site generator hugo. It's proven quite easy to use and had a great template to build our site off of.
You can find an example of the site running (same code & resources) here: https://nolski.github.io/example-librecorps-site/
There are still parts to fill in but I wanted to at least get the basics PR'd and submitted in order to get initial feedback.
As we have used markdown for majority of notes, I think keeping our notes in markdown is a good idea for now. We have six categories that we will be putting our resources into. You can find those categories below and the corrosponding resources:
├── [ 4.0K] ai/ │ ├── [ 206] _index.en.md │ ├── [ 3.3K] milestone-roadmap.md │ ├── [ 2.5K] model-card.md │ └── [ 2.2K] traps.md ├── [ 4.0K] community/ │ ├── [ 214] _index.en.md │ └── [ 2.8K] reading-list.md ├── [ 4.0K] legal/ │ ├── [ 2.3K] cla.en.md │ └── [ 169] _index.en.md ├── [ 4.0K] outreach/ │ └── [ 201] _index.en.md ├── [ 4.0K] product-management/ │ ├── [ 186] _index.en.md │ └── [ 3.4K] preliminary-interview-template.en.md └── [ 4.0K] tooling/ └── [ 189] _index.en.md
Creating new resources
If you wish to create a new resource under a category. Simply create a new markdown file containing the info you wish to have in the resource. Make sure you prepend a header describing the resource as below:
--- title: "Title of the Resource" date: 2019-09-03T11:02:05+06:00 # this is the date of the post type: "post" --- Rest of the resource goes here
jwflory left a comment
Awesome work @Nolski. Thanks for banging this out so fast. This PR is very large and since it contains the "initial" changes, I trust to deploy it first and then make smaller PRs if needed to fix things up.
My only change request is if you can please include the paragraph in this PR in a first header in a
Otherwise, I am