Signed-off-by: Daniel P. Berrangé <berrange@xxxxxxxxxx> --- README | 39 --------------------------------------- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 39 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index ad388f8..0000000 --- a/README +++ /dev/null @@ -1,39 +0,0 @@ - Virt Tools planet site - ====================== - -This directory contains content / configuration for managing - - http(s)://planet.virttools.org - http(s)://planet.virt-tools.org - -How to add your blog --------------------- -Add a config.ini section for your blog to updater/virt-tools/config.ini: - - [https://example.org/my/blog/feed/] - name = John Doe - face = jdoe.png - facewidth = 96 - faceheight = 96 - -Where face (logo image filename), facewidth (logo image width in pixels), and -faceheight (logo image height in pixels) are optional attributes that describe -the logo image associated with your blog. Remember to add your image file into -the updater/virt-tools/images/ directory if you wish to use an image. - -Please send a patch email to libvir-list@xxxxxxxxxx: - - $ git commit -as - $ git send-email --to libvir-list@xxxxxxxxxx --cc berrange@xxxxxxxxxx HEAD^.. - -How to run the site -------------------- -The site is setup to run under OpenShift - -Initial load can be done with - - oc process -f openshift/templates/virttools-planet.json | oc create -f - - -Updates to the OpenShift config are manually activated using 'oc replace'. - -Updates to the content itself are automatically propagated via a planet hook. diff --git a/README.md b/README.md new file mode 100644 index 0000000..68ae162 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +Virt Tools planet site +====================== + +This directory contains content / configuration for managing + +* [http://planet.virttools.org](http://planet.virttools.org) +* [http://planet.virt-tools.org](http://planet.virt-tools.org) + +How to add your blog +-------------------- +Add a config.ini section for your blog to `updater/virt-tools/config.ini`: + +``` + [https://example.org/my/blog/feed/] + name = John Doe + face = jdoe.png + facewidth = 96 + faceheight = 96 +``` + +Where `face` (logo image filename), `facewidth` (logo image width in pixels), +and `faceheight` (logo image height in pixels) are optional attributes that +describe the logo image associated with your blog. Remember to add your image +file into the `updater/virt-tools/images/` directory if you wish to use an +image. + +Please send a patch email to `libvir-list@xxxxxxxxxx`: + +``` + $ git commit -as + $ git send-email --to libvir-list@xxxxxxxxxx --cc berrange@xxxxxxxxxx HEAD^.. +``` + +How to run the site +------------------- + +The site is setup to run under OpenShift + +Initial load can be done with + +``` + oc process -f openshift/templates/virttools-planet.json | oc create -f - +``` + +Updates to the OpenShift config are manually activated using `oc replace`. + +Updates to the content itself are automatically propagated via a planet hook. -- 2.24.1
