madh-van/avoid-confluence

Sync up notes to confluence

PythonMIT

Avoid confluence

Problem

Are you tired of using the confluence web page regularly via the browser ?
Are you suffering from an outdated confluence page; constantly having to update the pages manually ?
Is your documentation not inline with the development changes ?

A problem indeed.

Solution

I personaly like to take notes in markup language like org in emacs and use Avoid confluence (ac) to keeps my documentaion up today.

Getting started

Copy the contents of examples/ to your notes dir and follow the naming conventions (avoid space)

20210209_103843--research-nn--notes-on-neural-network.org
<<UID>>--<<TAG>>--<<TITLE>>

Setup for the notes dir

Implicit assumptions; both Guix, and Direnv in installed globally.

# allow autoload of environment
direnv allow

# autoupdate to the latest commit of the project
pre-commit autoupdate

# to run test the project
pre-commit try-repo https://gitlab.com/madh-van/avoid-confluence  ac -v

# install hook to git by calling
pre-commit install

Dependencies

The following dependencies are used for this project.

atlassian-python-api to upload notes via its python api
pandoc vai pypandoc (python interface) for converting the notes to confluence markdown. (also called as ‘jira’)
precommit to automate the selection process of uploading modified notes.

Reference