Child pages
  • BP-11 - Move website/documentation to Jekyll based site
Skip to end of metadata
Go to start of metadata

 

Status

Current state: Done

Discussion thread:  N/A

JIRA: N/A

Released: 4.5

Problem

  • Currently the website and documentation is hosted separately. The documentation is in bookkeeper repo, while the websiste content is in Apache CMS repo.

  • Can't use github pull requests for reviewing website content changes.
  • There are too many manual steps for publishing documentation and website.

Proposal

  • Change the website/documentation build system to use static generators like Jekyll.

  • Copy the website content to bookkeeper main repo. So the source files of documentation and website both sit at bookkeeper main repo.
    • directory 'website' for keeping the static content that will rarely be updated.
    • directory 'docs' for keeping the content that is along with releases. they might be updated each release.
  • The generated static content will be kept in asf-site branch, hence the content will be automatically pushed to bookkeeper.apache.org.

Action

  • No labels