system-config/doc/source/planet.rst
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00

40 lines
1.1 KiB
ReStructuredText

:title: Planet
.. _planet:
Planet
######
The `Planet Venus
<http://intertwingly.net/code/venus/docs/index.html>`_ blog aggregator
is installed on ``planet01.openstack.org``.
At a Glance
===========
:Hosts:
* ``planet01.openstack.org``
* http://planet.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-planet/tree/
* :cgit_file:`modules/openstack_project/manifests/planet.pp`
:Configuration:
* https://git.openstack.org/cgit/openstack/openstack-planet/tree/planet.ini
:Projects:
* https://git.openstack.org/cgit/openstack/openstack-planet
* http://www.intertwingly.net/code/venus/
:Bugs:
* https://storyboard.openstack.org/#!/project/748
:Resources:
* `Planet Venus Documentation <http://intertwingly.net/code/venus/docs/index.html>`_
Overview
========
Planet Venus works by having a cron job which creates static files.
In our configuration, the static files are served using Apache.
The puppet module is configured to use the ``openstack/planet`` git
repository to provide the ``planet.ini`` configuration file. To add a
blog, propose an update to this file.