netresearch/deploy-rst

Deploys a README.rst file into a wiki, e.g. Confluence

v1.0.0 2016-12-28 13:16 UTC

Requires

• php: 5.3 - 7.0
• pear/config: *
• pear/console_commandline: ^1.1
• pear/system_folders: dev-master

AGPL 3

• Christian Weiske

• wiki
• rst
• reStructuredText

README

Deploys a README.rst file into a wiki, e.g. Confluence

Installation

$ pear channel-discover pear.nrdev.de
$ pear install nr/deployrst-alpha

Setup

$ cp `pear config-get cfg_dir`/DeployRst/config.php.dist ~/.config/deploy-rst
$ emacs ~/.config/deploy-rst
.. change user and password

Meta data in rST files

It is possible to embed wiki target meta data in the .rst files directly, so that you don't have to pass all parameters via command line.

Example:

.. meta::
   :deploy-target: confluence
   :confluence-host: http://confluence.example.org
   :confluence-space: IT
   :confluence-page: rstpagetest

Usage

Deployment with meta data in the .rst file:

$ ./deploy-rst.php README.rst

Without embedded meta data:

$ deploy-rst --driver=confluence --confluence-host=http://confluence.example.org\
  --confluence-space=IT --confluence-page=rstpagetest README.rst

Help:

$ ./deploy-rst.php --help

Dependencies

• rst2confluence
• Confluence Command line interface
• System from PEAR
• Console_CommandLine from PEAR