Planet for the Valkey Community

This repository contains the configuration required to generate the contents of Planet for the Valkey Community.

The current version of this file can be found in (1).

(1): https://github.com/jfg956/valkey-planet/blob/main/README.md

Software

The system is built using Planet Pluto: a Free Feed Reader and (Static) Website Generator.

Dependencies

Planet Pluto Software

As this system is built using the Planet Pluto Software, it needs to be installed first.

A Web Server

Planet Pluto only generates static web pages. For serving these you need a web server. Explaining how to install and configure a web server is out of scope of this README.

A Planet Pluto Template

Planet Pluto needs a template for generating static web pages. The template of Planet for the Valkey Community can be found in the template directory of this repository.

This template was derived from the template of Planet for the MySQL Community.

Static Files Generation How-to

Install Planet Pluto, below commands are doing that for Debian 10.

sudo apt-get -y install ruby-full build-essential libsqlite3-dev
sudo gem install pluto

Clone this repository.

git clone https://github.com/jfg956/valkey-planet.git

In the directory of the clonned repository, to build the valkey-demo template with output in the html directory, run this command (this updates the planet.db file or creates it)):

pluto build planet.ini -t valkey-demo -o ./html

To generate the static files without fetching the feeds, run this command:

pluto merge -t valkey-demo -o ./html

To fetch the feeds and update planet.db without generating static files, run this command:

pluto update

Feed Policy

The policy of what feeds are suitable for inclusion, along with guidance on how to propose changes to the feeds list, is available in the file aggregation_and_content_policy.md.