eco-infra / ecoinfra

Emission prediction tool
https://eco-infra.com
Apache License 2.0
6 stars 3 forks source link

Jekyll Documentation Site #30

Closed rickwysocki closed 4 months ago

rickwysocki commented 5 months ago

I wasn't sure if you wanted this pushed, so feel free to ignore it if now. This is a super-basic Jekyll install using the jekyll-docs theme, if you'd like to take a look at it. If it looks good, I'm happy to set up a structure for the documentation on the site based on your suggestions.

iamdavidmt commented 5 months ago

Think I read we needed the gh pages gem? but unsure. The domain is docs.eco-infra.com

I was looking at this: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll

rickwysocki commented 5 months ago

I'm not sure off the top of my head, but I'll double check. I'm traveling this weekend but will follow up early next week.

rickwysocki commented 5 months ago

Hey there: So, to set up GH Pages, you first need to set a publishing source under Settings > Pages: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

At that point, once you integrate/setup Jekyll, the site should automatically build within the folder you select.

iamdavidmt commented 4 months ago

@rickwysocki done, I've set the source to /docs/ see the current /docs/ dir and docs.eco-infra.com. I say we just merge this (if you could resolve conflicts please) and debug any issues.

rickwysocki commented 4 months ago

Hi there: Sorry this took a minute but I'm pretty sure I've reviewed the conflicts and it should be good now.

iamdavidmt commented 4 months ago

On build: https://github.com/eco-infra/ecoinfra/issues/31

rickwysocki commented 4 months ago

Pulling these changes now to look at this locally.

github-actions[bot] commented 4 months ago

:tada: This PR is included in version 1.14.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: