You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kibble.apache.org by hu...@apache.org on 2019/08/24 04:50:50 UTC
[kibble-website] 24/26: Added the README.md file with the build
instructions
This is an automated email from the ASF dual-hosted git repository.
humbedooh pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/kibble-website.git
commit 92cb007e52bc7e7c1f299ae1b4b60435e2d0ba6f
Author: Swapnil M Mane <sw...@apache.org>
AuthorDate: Tue Aug 20 18:14:06 2019 +0530
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).
---
BUILDING.txt | 12 ------------
README.md | 21 +++++++++++++++++++++
2 files changed, 21 insertions(+), 12 deletions(-)
diff --git a/BUILDING.txt b/BUILDING.txt
deleted file mode 100644
index df7b82f..0000000
--- a/BUILDING.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-NOTE: This is now handled by the buildbot, you only need to change the markdown
- files and the buildbot will regenerate the site and publish it.
-
-# Building the web site
-
-* Install the markdown module for Python 3: sudo pip3 install markdown
-* Edit or create the appropriate markdown file in source/ (you can have sub-dirs there)
-* open a shell, go to the source/ dir
-* Run: python3 generate.py
-* Commit the changes to git :)
-
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..375aca4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# 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.
+