|author||Andi Vajda <firstname.lastname@example.org>||Sat May 07 14:41:48 2022 -0700|
|committer||Andi Vajda <email@example.com>||Sat May 07 14:41:48 2022 -0700|
refreshed requirements and installation instructions
This repository contains the “source code” of the Lucene website at lucene.apache.org.
The site is written in Markdown syntax and built into a static site using Pelican. The site is re-built automatically by ASF Buildbot on every push to main branch and the result can be previewed at lucene.staged.apache.org. Build success/failure emails are sent to firstname.lastname@example.org mailing list. Read more about the mechanics behind auto building in INFRA Confluence.
If the staged site looks good, simply merge the changes to branch
production and the site will be deployed in a minute or two. Note that simple edits can also be done directly in the GitHub UI rather than clone -> edit -> commit -> push.
IMPORTANT: Please never commit directly to
productionbranch. All commits should go to main, and then merge main to production. Note that it is possible to make a Pull Request for the merge from
main-->production. If you do so, please merge using a merge commit rather than a squash merge.
For larger edits it is recommended to build and preview the site locally. This lets you see the result of your changes instantly without committing anything. The next sections detail that procedure. The TL;DR instructions goes like this:
# Usage: ./build.sh [-l] [<other pelican arguments>] # -l Live build and reload source changes on localhost:8000 # --help Show full help for options that Pelican accepts ./build.sh -l
Now go to http://localhost:8000 to view the beautiful Lucene web page served from your laptop with live-preview of updates :)
build.sh script mentioned in the above paragraph takes care of setting up your Pelican environment, and you can skip this part unless you want to understand the moving parts and install things by hand. Assuming that you have python3 installed, simply run:
pip3 install -r requirements.txt
If you run into conflicts with existing packages, a solution is to use a virtual Python environment. See the Pelican installation page for more details. These are quick commands, Linux flavor:
python3 -m venv env source env/bin/activate pip install -r requirements.txt
Once Pelican is installed you can convert your content into HTML via the pelican command (
content is the default location to build from).
The above command will generate your site and save it in the
output/ folder using the lucene theme and settings defined in
You can also tell Pelican to watch for your modifications, instead of manually re-running it every time you want to see your changes. To enable this, run the pelican command with the
--autoreload option. On non-Windows environments, this option can also be combined with the
--listen option to simultaneously both auto-regenerate and serve the output through a builtin webserver on http://localhost:8000.
pelican --autoreload --listen
Remember that on Mac/Linux you can use the
build.sh script with
-l option to do the same.
The release manager documentation will contain detailed instructions on how to update the site during a release. Some of the boring version number update and download link generation is handled by Pelican, see below.
JavaDoc publishing is not done through this repo, but in SVN as detailed in Release Manager instructions, and will then appear in respective sections of the website automatically, see
.htaccess for how.
There are variables in pelicanconf.py to modify the latest 2 supported release versions. This will affect all references to release version in the theme, but not in pages or articles. Pelican views pages and articles as static write-once, like a blog post, whereas the theme can be more dynamic and change with every build.
LUCENE_LATEST_RELEASE_DATE to affect