From 0d8fcb008d487b71aeaba7d8c25f254eb00a5052 Mon Sep 17 00:00:00 2001 From: bnewbold Date: Fri, 14 Jul 2017 22:34:03 -0700 Subject: start with everything but code --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..7517471 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ + +A simple python script for uploading markdown files to Confluence (a +proprietary wiki system). If you find yourself needing to publish documentation +to Confluence at work, but wish that instead you could just write markdown and +keep it versioned in git instead of contending with browser-mangling javascript +and pull-down menus, then this tool is for you! + +This is crude and one-way: there is no mechanism for synchronizing or retaining +edits made by peers, won't look the way you want it to, there are no unittests, +it will mangle your wiki space, and confound your sysadmins. Have Fun! + +# Installation and Setup + +You need **Python 3**, the **requests** python(3) library, and **pandoc** +installed first: + + # debian/ubuntu + sudo apt install python3 python3-requests pandoc + + # homebrew? guessing here + sudo brew install python3 py3-requests pandoc + +To experiment you can checkout this repo and run commands locally. If you like +it you can install system-wide with: + + sudo make install + +On the Confluence side, it uses the newer REST API (not the old XML-RPC API) +and generates complete pages in "Confluence storage" syntax, so if you're lucky +it will Just Work without needing any administrative intervention. + +# Usage + + export CONFLUENCE_USER=`whoami` + export CONFLUENCE_PASSWORD="password123" + export CONFLUENCE_URL="https://evil-corp.jira.com/wiki/" + ./divergence -s "PROD25" Acme_Widget_Docs.md + +This will create a new page "Acme Widget Docs" under the space with ID +"PROD25" (or overwrite it if it already exists). When experimenting you +probably want to use your personal space, which will be something like +"~bitdiddle". If you blow away something accidentally, it should be possible to +revert the push in the wiki interface (this has not been verified). + +Multiple files can be uploaded at the same time. + +If you have in-line images you'll need to upload them manually. Haven't tried +it yet. + -- cgit v1.2.3