Code powering the Apache Fluo website (https://fluo.apache.org). Contributing describes how to test locally.
Below are the steps required to update the Fluo project website for a new release of Fluo or Fluo Recipes. The steps below assume you are releasing Fluo 1.2.0. For a Fluo Recipes release, replace any reference to fluo
with recipes
.
Confirm that Javadocs for the release are hosted externally
Modify _config.yml
for the new release:
latest_fluo_release
to 1.2.0
fluo-1-2
collectionRemove the “Future release” warning from the Fluo docs layout in _layouts/fluo-1.2.html
Add link to 1.2 documentation in docs/index.md
.
Add link to 1.2 javadocs in pages/api.md
.
If a post exists for the release in _posts/release
, update the date and remove draft: true
from the post to publish it. Otherwise, create a post with release notes and resources to announce the release.
Below are steps to create documentation for the next release of Fluo or Fluo Recipes. The directions below are for creating Fluo 1.3 docs from 1.2 docs. For Fluo Recipes documentation, replace any reference to fluo
with recipes
.
Create the Fluo 1.3 docs from the 1.2 docs
cp -r _fluo-1-2 _fluo-1-3
Create a fluo-1.3.html
layout and update any collection references in it to fluo-1-3
. You should also add a warning banner to notify users that it's for a future release.
cp _layouts/fluo-1.2.html _layouts/fluo-1.3.html vim _layout/fluo-1.3.html
Update _config.yml
by adding a fluo-1-3
collection and setting default values for it. You may want to keep 1.2 values for github & javadocs until 1.3 is released.
Changes pushed to our main
branch will automatically trigger Jekyll to build our site from that branch and push the result to our asf-site
branch, where they will be served on our production site.