Google Git
Sign in
apache / kibble-website / 251bcc59fe4fdc6e4bbd196f6b49e59377af0c73
commit251bcc59fe4fdc6e4bbd196f6b49e59377af0c73[log] [tgz]
authorSwapnil M Mane <swapnil.mane@hotwaxsystems.com>Tue Aug 20 18:14:06 2019 +0530
committerSwapnil M Mane <swapnil.mane@hotwaxsystems.com>Tue Aug 20 18:14:06 2019 +0530
tree3eb24b73c2dca049d56d68c3af2141f049451467
parentca67b845ef14350e4053b48257987e5480fe300e [diff]
Added the README.md file with the build instructions

Also added the details on how to verify the changes.
The purpose behind adding README.md file is, the content for this file is automatically rendered at the home page of Git repository on GitHub (https://github.com/apache/kibble-website).
2 files changed
tree: 3eb24b73c2dca049d56d68c3af2141f049451467
  1. content/
  2. source/
  3. LICENSE
  4. README.md
README.md

Kibble Official Website

This project keeps all sources used for building up Kibble official website, served at https://kibble.apache.org.

Prerequisite

  • Python 3
  • Python 3 markdown module (Install by running command sudo pip3 install markdown)

Build instruction

  1. Edit or create the appropriate markdown file in kibble-website/source/ (you can have sub-dirs there)
  2. Open a shell, go to the kibble-website/source/ dir
  3. Run python3 generate.py command
  4. To verify your change locally, go to kibble-website/content directory Run python -m SimpleHTTPServer 8000 command The website http://localhost:8000/
  5. Commit the changes to git :)

Note: For production site https://kibble.apache.org, the buildbot will regenerate the site from the markdown files and publish it.