https://github.com/apache/celix-site

Website sources for the Apache Celix website
https://github.com/apache/celix-site

apache celix hugo

Last synced: 9 days ago
JSON representation

Website sources for the Apache Celix website

• Host: GitHub
• URL: https://github.com/apache/celix-site
• Owner: apache
• License: apache-2.0
• Created: 2017-10-13T07:00:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T20:35:20.000Z (10 days ago)
• Last Synced: 2025-01-28T21:32:40.926Z (10 days ago)
• Topics: apache, celix, hugo
• Language: JavaScript
• Homepage: https://celix.apache.org/
• Size: 4.33 MB
• Stars: 8
• Watchers: 14
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Apache Celix website

This is the source code for the website of [Apache Celix](https://celix.apache.org/), hosted at:

    https://celix.apache.org/

## Repository structure

This repository uses 2 branches for serving the website.

- The `master` branch, which contains all the sources for the website.

- The `asf-site` branch, which contains the generated website being used for the Celix website.

When contributing patches, apply them to the `master` branch. Jenkins will then regenerate the website

and commit the changes to the `asf-site` branch.

## Content Management System

The Celix website uses Hugo as static website generator. 

See [Hugo](https://gohugo.io/) for more info and for details how to install Hugo.

## Generate the website

### Copy documentation dir from celix repo

 - Run `git submodule init` and `git submodule update` to retrieve the Celix sources.

 - Run `./extract_celix_docs.sh ""` to copy the markdown files from the Celix main repository to the site repository.

 - Create a docs.md in the just updated celix documentation at `source/docs/X.Y.Z/docs.md. The docs.md can be based on the previous celix documentations docs.md file.

### Doxygen documentation

 - Run `./generate_celix_doxygen.sh ""` to generate the Doxygen pages for the specified Celix release.

### Generate the static website

To generate the static website, execute `hugo` 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 is used for generating the website and committing the generated site to the `asf-site` branch.