getzola / zola

A fast static site generator in a single binary with everything built-in. https://www.getzola.org
https://www.getzola.org
MIT License
13.76k stars 956 forks source link

Documentation use with Github Pages is outdated #1117

Closed jjbarr closed 4 years ago

jjbarr commented 4 years ago

At present, the documentation for using Zola with GitHub Pages is outdated, and using it as it currently stands will result in confusing, unexpected behavior. Most notably, Zola will not successfully run at all in the default Travis environment: you need to add dist: bionic to the top of the file to get a newer Ubuntu (and a newer version of libssl, which is the actual issue).

Additionally, if the user does not change the link provided for downloading Zola, they will end up with 0.9.0 in travis. This will cause confusing issues: RSS and Atom feeds won't be generated correctly, as the configuration option for doing so has changed since 0.9.0's release. This technically isn't a bug, as the documentation explicitly states to update the link to the version you want, but it's probably a good idea to have a reasonable default.

Proposed solution

Update the current example .travis.yml so that it will actually run successfully and build a site, and doesn't have versioning pitfalls lying in wait.

schoenenberg commented 4 years ago

@jjbarr I suggest adding a description for GitHub Actions as well. I prefer to have everything integrated into one tool instead of multiple tools.

In the theme zola-paper (see action: main.yml) I already implemented it with GitHub Actions. Also had a discussion with @reisub0 about the token see here.

therealprof commented 4 years ago

I also have it integrated with GH actions, you can check it out here and steal whatever you like: https://github.com/therealprof/therealprof.github.io/blob/code/.github/workflows/zola.yml

Keats commented 4 years ago

It would be nice if someone could a PR to update the docs. I would recommend using GH action in the new docs rather than Travis too.

schoenenberg commented 4 years ago

Starting work on it.

Keats commented 4 years ago

Thanks @schoenenberg !