docToolchain / docToolchain/docs-as-co.de

try to publish the easy example to confluence

Open
#67 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
12
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Hi there,

i would like to ask for assistance. It was very easy (and a nice experience, too ❤️ ) to follow the simple Tutorial on https://docs-as-co.de/getstarted --> The Build-Tool Approach --> Gradle.

calling the asciidoctor task (see below) created the test.html file

After having created the test.html file i wanted to publish that to confluence.

I researched the gradle plugin https://plugins.gradle.org/plugin/de.docs-as-co.publishToConfluence ... but i was not able to find out how to configure it. ... I also looked at http://doctoolchain.org/docToolchain/v2.0.x/015_tasks/03_task_publishToConfluence.html#_configuration ... and tried that ... but i am not doing it the right way 😢

Could you/someone maybe answer with a (configured the right way way 🤷 ⁉️ ) gradle task config for my build.gradle file for the following setup: (the part in the task `asciidocToConfluence` seems to be improvable 😅 )

Thank you in advance, if you maybe be able to help me!

As an alternative: do you know any github repos that show a working setup for "publishing to confluence"? I then could look at that, and maybe repair it myself ✊

```groovy
asciidoctor {
// sourceDir file('docs/asciidoc')
// sources {
// include 'toplevel.adoc', 'another.adoc', 'third.adoc'
// }
// outputDir file('build/docs/asciidoc')
}

asciidocToConfluence {

input = [
[ file: "build/docs/asciidoc/test.html" ],
]

// endpoint of the confluenceAPI (REST) to be used
api = 'https://confluence.host.url/rest/api/'

// the key of the confluence space to write to
spaceKey = '$CONF_SPACE_KEY'

// variable to determine whether ".sect2" sections shall be split from the current page into subpages
createSubpages = false

// the pagePrefix will be a prefix for each page title
// use this if you only have access to one confluence space but need to store several
// pages with the same title - a different pagePrefix will make them unique
pagePrefix = 'Testtest - '

// username:password of an account which has the right permissions to create and edit
// confluence pages in the given space.
// if you want to store it securely, fetch it from some external storage.
// you might even want to prompt the user for the password like in this example

credentials = "$user:$password".bytes.encodeBase64().toString()
}
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the build.gradle snippet, the asciidocToConfluence task, and the linked publishToConfluence configuration documentation. Compare the task settings with the Gradle plugin and docToolchain examples; done means a documented working configuration for publishing test.html to Confluence or a linked repository showing one.

Written by the indexing model from the issue text.

Assessment

Tech stack
groovy
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.