copy properly
1 file changed
tree: 878b6377db5748f45014cd1ab2ed3357e005c3e1
  1. archetypes/
  2. content/
  3. themes/
  4. .asf.yaml
  5. .gitignore
  6. config.toml
  7. Jenkinsfile
  8. README.md
README.md

Apache Security website

This is the source code for the website of the Apache Security Team, hosted at:

https://security.apache.org/

Repository structure

This repository uses 2 branches for serving the website.

  • The main branch, which contains all the sources for the website.
  • The asf-site branch, which contains the generated website being used for the Apache Security Team website.

When contributing patches, apply them to the main branch. Jenkins will then regenerate the website and commit the changes to the asf-site branch.

Content Management System

The Apache Security Team website uses Hugo as static website generator. See Hugo for more info and for details how to install Hugo.

Generate the website

To generate the static website, execute hugo server to generate and serve the website on localhost:1313.

During development, it may be useful to run an incremental build. For this to work, execute hugo server -D to continuously generate and serve the website on localhost:1313.

Publish the website

Jenkins will be used for generating the website and committing the generated site to the asf-site branch once we obtain the authorization to create that job.

Until then this is a manual process:

  • run hugo to generate the site
  • switch to the asf-site branch
  • copy the public/ resources into the root of the repo
  • commit and push