Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionShows how to add the Apptools Maven Plugin to your Confluence add-on project.
Doctypetopichide
NameUse in App Project
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
valuefinished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort KeyBASIC-0010-0010hide



Section
show-titlefalse
titleDescription

The following shows a configuration where the different target environments are configured with the POM file. This makes the different environments immediately accessible to users of the project.

Unfortunately this configuration lacks flexibility in case you administrate more than one project. In this case you may want to check the alternative configuration we show at the end of this tutorial.


Section
titleSummary


Section
titlePrerequisites

...

Transclusion
render-document-name-as-headingtrue
taget-heading-level*
documentConfigure Servers
ids*,!p_for_build_profiles,!Resources,!References
tags!additional_help


Section
titleAlternative Configuration

This configuration has advantages when environments need to be added or removed.

With the configuration explained above you would need to alter the POM file of every project. You can keep this configuration effort local to the settings file if you use the following configuration in your POMs:

Code Block Placeholder
code-languageHTML and XML
code-titlepom.xml
<build>
  ...
  <pluginManagement>
    <plugins>
      ...
      <plugin>
        <groupId>de.smartics.maven.plugin</groupId>
        <artifactId>apptools-maven-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          ... <!-- same as above, plus: -->

          <serverId>${my-project.apptools.remote.server.id}</serverId>
          <serverUrl>${my-project.apptools.remote.server.url}</serverUrl>
        </configuration>
      </plugin>
    </plugins>
  </pluginManagement>
  ...
</build>

Then in your settings.xml add the following as a profile element for each of your environments.

Code Block Placeholder
code-languageHTML and XML
code-titlesettings.xml
<settings>
  ...
  <servers>
    <server>
      <id>my-server-id</id>
      <username>janedoe</username>
      <password>{swldfcm .... ssdfsdaf323=}</password>
    </server>
  </servers>

  ...

  <profiles>
    <profile>
      <id>MY_ENV_ID</id>
      <properties>
        <projectdoc.apptools.remote.server.id>my-server-id</projectdoc.apptools.remote.server.id>
        <projectdoc.apptools.remote.server.url>https://myserver/confluence</projectdoc.apptools.remote.server.url>
      </properties>
    </profile>
  </profiles>
</settings>



Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...