nutch-site's Introduction

Nutch Website

This repository contains the website source code for the Apache Nutch project.

Credits

Built using the kube Theme for Hugo.

Tooling

The Website is built using Hugo a popular open-source static website generation framework.

Prerequisites

Install Hugo

Serve the Site Locally

Change into the project directory and execute

$ hugo server -w
...
Start building sites …

                   | EN
-------------------+-----
  Pages            | 10
  Paginator pages  |  0
  Non-page files   |  0
  Static files     | 10
  Processed images |  0
  Aliases          |  0
  Sitemaps         |  1
  Cleaned          |  0

Built in 107 ms
Watching for changes in /path/to/nutch_site/{archetypes,content,data,layouts,static,themes}
Watching for config changes in /path/to/nutch_site/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Creating new Content

Check out the Kube documentation. Any further questions should be asked on the Nutch dev@ mailing list.

Contributing

The process is the same as for the Nutch codebase.

Building and Publishing the Site

To deploy a static site build execute

hugo --destination static_site

The static site is kept in this directory in the branch asf-site in the folder content/ and automatically deployed onto the public Nutch website. See the Apache Infra project website docs and the configuration file .asf.yaml. The branch asf-staging is used for deploying the staging site https://nutch.staged.apache.org/.