search

EclipseFdn / hugo-eclipsefdn-website-boilerplate

This boilerplate was created to help Eclipse Projects migrate their website to Hugo!
https://eclipsefdn-hugo-solstice-theme.netlify.app/
Eclipse Public License 2.0
0 stars 3 forks source link

Provide documentation for building a Hugo-based project website #2

Open chrisguindon opened 6 years ago

chrisguindon commented 6 years ago

The content of exampleSite in this project is served via github pages: https://eclipsefdn.github.io/hugo-solstice-theme/

The exampleSite should include documentation and instructions to build a Hugo-based project website.

@waynebeaton created an issue to include the instruction in the handbook. We should synchronize our effort to avoid duplication: https://bugs.eclipse.org/bugs/show_bug.cgi?id=538665

Here's some inscriptions that I posted on the incubation mailing list which we could use at a starting point.

I recommend using our eclipsefdn-hugo-solstice-theme to get started since it includes all the Eclipse Foundation project website requirements such as our cookie consent banner and our google tag manager ID.

Hugo is very flexible content management system. For example, iot.eclipse.org is now built using our eclipsefdn-hugo-solstice-theme without the usual EF look and feel.

If you are looking for example on how to setup your project, I would recommend taking a look at the following website git repos: jakarta.ee https://github.com/jakartaee/jakartaee.github.io iot.eclipse.org https://github.com/EclipseFdn/iot.eclipse.org Our Hugo projects are using NPM to manage dependencies, such as our theme: https://www.npmjs.com/package/eclipsefdn-hugo-solstice-theme

You can install the latest version of the theme via the following command: npm install eclipsefdn-hugo-solstice-theme --save

The source code of our theme includes a website example via the exampleSite folder: https://github.com/EclipseFdn/hugo-solstice-theme/tree/master/exampleSite

If you chose to install our theme using NPM, you will need to update the themeDir variable in your config.toml file to let Hugo know where to find your theme:

themesDir = "node_modules/"

autumnfound commented 3 years ago

Should we change this to reference the boilerplate project that we've recently created, rather than duplicating the documentation here?

chrisguindon commented 3 years ago

Yes, I have an MBO this quarter to finalize the documentation. The plan is definitely to point all existing documentation to the boilerplate.

The last remaining piece is documenting how they can build a project using Gitlab.

chrisguindon commented 3 years ago

I will move this to the boilerplate project so I that I don't forget to update the handbook and wiki.

chrisguindon commented 3 years ago

If someone stumbles on this issue, the instructions for Jenkins are here: https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate#how-to-build-my-projects-website-with-jenkins