Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert site to Hugo #112

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jamietanna
Copy link
Contributor

As part of #98, we decided that we wanted to replace the single HTML
file with a static site generator.

This allows for easier adding/changing of content and theme, as
currently the setup of the site will make it a little difficult to
change the structure of the site in the future, and it also makes it
easier for folks to contribute changes to the events on the site.

We've decided to use Hugo, as a lightweight solution that only requires
a single download to get it working.

To make this work and automagically deploy on merges, we need to use
GitHub Actions.

We no longer need anything Gulp/Node related, as Hugo can minify our
source for us, so we can remove those references.

Closes #98.

As part of nottinghamdigital#98, we decided that we wanted to replace the single HTML
file with a static site generator.

This allows for easier adding/changing of content and theme, as
currently the setup of the site will make it a little difficult to
change the structure of the site in the future, and it also makes it
easier for folks to contribute changes to the events on the site.

We've decided to use Hugo, as a lightweight solution that only requires
a single download to get it working.

To make this work and automagically deploy on merges, we need to use
GitHub Actions.

We no longer need anything Gulp/Node related, as Hugo can minify our
source for us, so we can remove those references.

Closes nottinghamdigital#98.
It appears that this link has been broken for some time - we should fix
it so clients respecting the value can use it.
@jamietanna
Copy link
Contributor Author

A quick note I forgot to mention - we'll need to tweak the way that GitHub pages is set up for this project before this is merged. Please see https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token

@sdh100shaun
Copy link
Collaborator

sdh100shaun commented Oct 3, 2020

what's the process for local development ? do we need to updte readme and contributing guides?

@jamietanna
Copy link
Contributor Author

Sorry yes that's a very good point! Regarding local dev, unless folks are making more involved changes, don't necessarily need Hugo, as they can just contribute a new event, but I'll add the details in.

In terms of contributing, I'd had a look at contributor-guide.md and was wondering how best to do this, as the details in there aren't as technical as "go to this file, add a new thing" -but I guess we'd be happy with me making it a bit more like that?

@jhigman
Copy link
Collaborator

jhigman commented Oct 24, 2021

Hi @sdh100shaun sorry, I'm away at the moment, and not getting much time to try this out - happy to go ahead with it if it runs OK for you, but a couple of questions - is it obvious how to add new events, and are there dev instructions for build and deploy (git tokens etc)?

@sdh100shaun
Copy link
Collaborator

sdh100shaun commented Oct 24, 2021

I have pulled down will look at this @jamietanna is there to be instructions for updating?

@jamietanna
Copy link
Contributor Author

What do you mean sorry?

@sdh100shaun
Copy link
Collaborator

sdh100shaun commented Oct 31, 2021

What do you mean sorry?

Just if there is a guide to updating Jamie .. ah found contirbuting.md can it be updated with instructions for creating content

Have applied hacktoberfest accepted as this is the direction we want to go - need to sort some merge conflicts then good to go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move to use of a Static Site Generator
3 participants