https://github.com/apache/fluo-website
Apache Fluo Website
https://github.com/apache/fluo-website
accumulo asf-site big-data fluo hacktoberfest
Last synced: 4 months ago
JSON representation
Apache Fluo Website
- Host: GitHub
- URL: https://github.com/apache/fluo-website
- Owner: apache
- License: apache-2.0
- Created: 2016-06-24T07:00:05.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T00:24:32.000Z (6 months ago)
- Last Synced: 2025-01-30T10:23:51.620Z (4 months ago)
- Topics: accumulo, asf-site, big-data, fluo, hacktoberfest
- Language: HTML
- Homepage: https://fluo.apache.org
- Size: 4.52 MB
- Stars: 6
- Watchers: 13
- Forks: 27
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Apache Fluo website
[![Build Status][ti]][tl] [![Apache License][li]][ll]
Code powering the Apache Fluo website ([https://fluo.apache.org][production]).
[Contributing](CONTRIBUTING.md) describes how to test locally.
## Update website for new release
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`.
1. Confirm that Javadocs for the release are hosted externally
2. Modify `_config.yml` for the new release:
* Set `latest_fluo_release` to `1.2.0`
* Verify default values (i.e Javadoc & GitHub URLs) set for `fluo-1-2` collection
3. Remove the "Future release" warning from the Fluo docs layout in `_layouts/fluo-1.2.html`
4. Add link to 1.2 documentation in `docs/index.md`.
5. Add link to 1.2 javadocs in `pages/api.md`.
6. 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.
## Create documentation for next 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`.
1. Create the Fluo 1.3 docs from the 1.2 docs
cp -r _fluo-1-2 _fluo-1-3
2. 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
3. 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.
## Publishing
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][production].
[Jekyll]: https://jekyllrb.com/
[production]: https://fluo.apache.org
[ti]: https://github.com/apache/fluo-website/workflows/CI/badge.svg
[tl]: https://github.com/apache/fluo-website/actions
[li]: http://img.shields.io/badge/license-ASL-blue.svg
[ll]: https://github.com/apache/fluo-website/blob/main/LICENSE