Skip to content

Commit

Permalink
Improve configuration explanation for users
Browse files Browse the repository at this point in the history
Expended the input documentation with the possibilities that the current implementation already has.
This is very useful for first time users and users that don't look in the underlying code.
Making these configuration possibilities obvious, can attract more users in selecting this product.
  • Loading branch information
madegroot committed Oct 22, 2018
1 parent c506279 commit 7e802ae
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Config.groovy
Expand Up @@ -30,9 +30,14 @@ confluence = [:]
// - 'file': absolute or relative path to the asciidoc generated html file to be exported
// - 'url': absolute URL to an asciidoc generated html file to be exported
// - 'ancestorId' (optional): the id of the parent page in Confluence; leave this empty
// if a new parent shall be created in the space
// if a new parent shall be created in the space
// - 'preambleTitle' (optional): the title of the page containing the preamble (everything
// before the first second level heading). Default is 'arc42'
// before the first second level heading). Default is 'arc42'
// - 'spaceKey' (optional): page specific variable for the key of the confluence space to write to
// - 'createSubpages' (optional): page specific variable to determine whether ".sect2" sections shall be split from the current page into subpages
// - 'pagePrefix' (optional): page specific variable, the pagePrefix will be a prefix for the page title and it's sub-pages
// 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
//
// only 'file' or 'url' is allowed. If both are given, 'url' is ignored
confluence.with {
Expand Down Expand Up @@ -68,4 +73,4 @@ confluence.with {
// extraPageContent = '<ac:structured-macro ac:name="warning"><ac:parameter ac:name="title" /><ac:rich-text-body>This is a generated page, do not edit!</ac:rich-text-body></ac:structured-macro>
extraPageContent = ''
}
//end::confluenceConfig[]
//end::confluenceConfig[]

0 comments on commit 7e802ae

Please sign in to comment.