create confluence space from adoc (or another intermediate format)

arc42 / arc42-template

arc42 - the template for software architecture documentation and communication

https://arc42.org

Other

1.02k stars 178 forks source link

create confluence space from adoc (or another intermediate format) #6

Closed rdmueller closed 7 years ago

rdmueller commented 10 years ago

create a gradle build step which converts the subset of adoc which is sued by arc42 into a confluence space. Target will be the current confluence on demand version (5.3), but goal will be to support as many older versions as possible (let's see what the confluence api will provide us)

let's define some acceptance criteria: A1: export should look "nice" A2: if possible, a new export should only add to the confluence history when pages have been changed A3: images have to be exported

rdmueller commented 10 years ago

X created confluence on demand account X succeeded with creating a first page through REST API with groovy

rdmueller commented 10 years ago

pushing arc42 to confluence with a flat hirachy already works quite well.

will now try to create a deeper hirachy and integrate it into the build

rdmueller commented 10 years ago

a hirachy of two levels works now.

gernotstarke commented 10 years ago

you're herewith awarded our hero medal... thx!!

Gernot

Dr. Gernot Starke +49-177-7282570 gs@gernotstarke.de www.gernotstarke.de

Von einem mobilen Geraet gesendet - bitte verzeihen Sie eventuelle Tippfehler.

Am 05.09.2014 um 22:53 schrieb Ralf D. Müller notifications@github.com:

a hirachy of two levels works now.

— Reply to this email directly or view it on GitHub.

rdmueller commented 10 years ago

still some open issues: [ ] check if a page has been modified - confluence modifies the posted html a little bit, so this is a bit tricky [ ] upload images to confluence [ ] include groovy scrip in gradle build

gernotstarke commented 7 years ago

I'd be VERY interested to add confluence to the supported build targets:

it needs to be a version that can be "imported" into an existing space (so it does not need to be a space on its own)
the "with-help" version should contain help as "show-on-demand"
we might even skip the "plain" version...

rdmueller commented 7 years ago

the docToolchain can handle confluence - but not as import:

It generates HTML from AsciiDoc and publishes this as several pages to confluence. Help is published as "show-on-demand".

This enables you to

specify a page prefix... interesting for users who can't create new confluence spaces (corporate confluence)
export the confluence space afterwards (may be could automate this...)
docToolchain is independent of the confluence version - only on the REST API

gernotstarke commented 7 years ago

we can create confluence space - therefore I close this...