Giter Club home page Giter Club logo

deploy-rst's Introduction

deploy-rst

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

deploy-rst's People

Contributors

cybottm avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

mt3 zakstar

deploy-rst's Issues

Add support for others options.

I think it will be very nice to have support for others options which will allow pass this to confluence-cli.

For example. I am adding page to confluence from RST and everything seems be working fine, but I can't add more arguments to parameters:

storePage - Create or update a page.
        Required parameters: space and title or id, content or file
        Optional parameters: parent, labels, comment, minor, content2, findReplace, findReplaceRegex
 noConvert, markdown, encoding

All of this parameters are important - and for example there is option about parent which I need.

Hope that helps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.