Versions Compared

Key

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

...

Section


Column


Document Properties Marker
doctyperelease-note
overridefalse


Short DescriptionImprovements heading to data center support. Requires rebuild of database table which may take up to hours to run.
Nameprojectdoc Toolbox 5.0 alpha Release Notes
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

Iteration

Iteration
valueproduction

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

Version5.0hide
Productprojectdoc Toolboxhide
Release Date

 

hide
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Key00005.00000.0004hide



Caution Box
titleAlpha Status - Version 5.0.4

This version 5 of the projectdoc Toolbox is currently alpha.

We are rolling out this version on instances of selected customers.

It is currently not publicly available on the Atlassian Marketplace.


Section
show-titlefalse
titleDescription

Today we released version 

Display Property
property-nameVersion
of the projectdoc Toolbox. It includes changes from version 5.0.0 to 5.0.4.

Content Marker
hidetrue

This version has been made available on the Atlassian Marketplace.

Since this is a major release, expect breaking changes!

Please read this release notes carefully prior to updating the projectdoc Toolbox!

This version 5 includes a couple of changes required for data center support. Data center support is planned to be supported by the major version of the projectdoc Toolbox.

Content Marker
hidetrue


Info Box

Download the projectdoc Toolbox or visit the projectdoc Toolbox on the Atlassian Marketplace!




Panel
titleNew here? What is the projectdoc Toolbox?

The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation. 


Section
titleSummary

This version provides

  • Preparation for Confluence Data Center
  • Support for Confluence Server version 7.4.14 to 7.16.x.
  • Improvements in the user interface

This release has breaking changes. Therefore it is required to update extensions and doctype add-ons.



Column
width350px


Panel
titleRelease Notes Overview

Table of Contents
indent15px
excludeRelease Notes|Description|Summary|"References"|Resources
stylenone



...

Section
titleNew and Noteworthy

Very quickly the most relevant changes in this release.

Section
titlePreparation for Data Center Support

This version add some performance improvements to support Confluence Data Center (DC). This also includes support for the Confluence Read-Only Mode (a must have for DC)

Section
titleEditing Experience

A couple of improvements address the user experience when working with projectdoc documents in the Confluence page editor.

All these features are considered experimental and are currently in an early release status with some limitations (for details please follow the links below).

  1. Static Document Link
    documentSection Expander
    : Macros in the page editor can be collapsed or expanded
    Image Removed
  2. Static Document Link
    documentSection Navigation
    The editor can be opened at a specified location
    Image Removed
  3. Static Document Link
    documentDynamic Editor Content
    : Provides dynamic content generated by macros when in the page editor
    Image Removed

One of the most relevant news for your upgrade is the new database structure the projectdoc Toolbox. Since the projectdoc tables did not store any information that cannot be derived from the Confluence pages, you simply need to rebuild the table data from scratch. Unfortunately this requires – especially for large installations – quite a lot of time. We recommend to check the upgrade process in a test environment on real data to get an estimation about how long this would take on your Confluence instance.

Content Marker
hidetrue


Pending Box
titleHere are some estimates from our test and production environments

Estimates?

...

Pro projectdoc Dokument ca 0,3 Sekunden. Nicht PD Dokumente sind nicht betroffen.

Beispiele:

1000 Dokumente = 300s = 5 Min

10.000 Dokumente = 3.000s = 50 Min

100.000 Dokumente = 30.000s = 8:20 Stunden



This also includes support for the Confluence Read-Only Mode (a must have for DC)

Section
titleReading Experience

A new feature allows readers to collapse or expand sections.

The chevron icon allows to hide the contents of a section and therefore allows the user to focus.

Image Removed

For more information, please visit 

Static Document Link
documentSection Collapse
.


Features that interact with the user interface may now be configured to be activated or deactivated by user groups.

Image Removed

More information for these features are found on 
Section
titleAdministration UIEditing Experience

A couple of improvements address the user experience when working with projectdoc documents in the Confluence page editor.

All these features are considered experimental and are currently in an early release status with some limitations (for details please follow the links below).

  1. Static Document Link
    documentSection Expander
    : Macros in the page editor can be collapsed or expanded
    Image Added
  2. Static Document Link
    documentSection Navigation
    The editor can be opened at a specified location
    Image Added

The administration user interface provides new elements.

Image Removed

Section
titleFeatures
Static Document Link
document
Doctools
Dynamic Editor Content
: Provides dynamic content generated by macros when in the page editor
Image Added.


Section
titleRebuilder UIReading Experience

A new feature allows readers to collapse or expand sections.

The chevron icon allows to hide the contents of a section and therefore allows the user to focus.

Image Added

For more information, please visit 

The rebuild processes may be launched via the administration user interface. The REST services, providing more configuration options, are still available, tough.

Image Removed

For more information on the Rebuild Service, please refer to the

Static Document Link
documentprojectdoc Rebuild ManualSection Collapse
.


Section
titleDatabase Tables

We updated the database tables to store projectdoc data. This is required to cope with the increased load on Confluence when run in a data center environment.

The old tables (identified by "PD_" in the table name) will stay untouched and the new structures will be stored in new tables (identified by "PD5_"). Even if the old data will still be available we highly recommend to have access to a current backup of your database.

Example Box
titlePD5 Tables
  1. AO_63F547_PD5_DOC
  2. AO_63F547_PD5_NAME_REFS
  3. AO_63F547_PD5_PAGE_REFS
  4. AO_63F547_PD5_PG_FRGMNT
  5. AO_63F547_PD5_PROP

The upgrade process will only affect projectdoc tables in Active Objects (AO). In case the process cannot complete successfully, because an accidental server downtime, please clear (not drop) the new PD5 tables from corrupt content and restart the server. The process can also be started manually via a

Term Link
abbrev-modeshort-name
fullyQualifiedModefalse
maximumSelectionSize1
supportTaggingtrue
focustrue
pageRepresentational state transfer
multiSelecttrue
service.

For more information on updating information in the projectdoc database tables, please refer to 

Static Document Link
documentprojectdoc Rebuild Manual
, especially
Static Document Link
anchorUpgrade Task
documentprojectdoc Rebuild Manual
labelUpgrade Task
.

Section
titleSummary
Administration UI

The administration user interface provides new elements.

Image Added


Section
titleFeatures

Features that interact with the user interface may now be configured to be activated or deactivated by user groups.

Image Added

More information for these features are found on 

Static Document Link
documentDoctools
.



Section
titleRebuilder UI

The rebuild processes may be launched via the administration user interface. The REST services, providing more configuration options, are still available, tough.

Image Added

For more information on the Rebuild Service, please refer to the

Static Document Link
documentprojectdoc Rebuild Manual
.


Section
titleDatabase Tables

We updated the database tables to store projectdoc data. This is required to cope with the increased load on Confluence when run in a data center environment.

The old tables (identified by "PD_" in the table name) will stay untouched and the new structures will be stored in new tables (identified by "PD5_"). Even if the old data will still be available we highly recommend to have access to a current backup of your database.

Example Box
titlePD5 Tables
  1. AO_63F547_PD5_DOC
  2. AO_63F547_PD5_NAME_REFS
  3. AO_63F547_PD5_PAGE_REFS
  4. AO_63F547_PD5_PG_FRGMNT
  5. AO_63F547_PD5_PROP

The upgrade process will only affect projectdoc tables in Active Objects (AO). In case the process cannot complete successfully, because an accidental server downtime, please clear (not drop) the new PD5 tables from corrupt content and restart the server. The process can also be started manually via a

Term Link
abbrev-modeshort-name
fullyQualifiedModefalse
maximumSelectionSize1
supportTaggingtrue
focustrue
pageRepresentational state transfer
multiSelecttrue
service.

For more information on updating information in the projectdoc database tables, please refer to 

Static Document Link
documentprojectdoc Rebuild Manual
, especially
Static Document Link
anchorUpgrade Task
documentprojectdoc Rebuild Manual
labelUpgrade Task

This version addresses the increased performance requirements for data center.

One of the most relevant news for your upgrade is the new database structure the projectdoc Toolbox. Since the projectdoc tables did not store any information that cannot be derived from the Confluence pages, you simply need to rebuild the table data from scratch. Unfortunately this requires – especially for large installations – quite a lot of time. We recommend to check the upgrade process in a test environment on real data to get an estimation about how long this would take on your Confluence instance.

Content Marker
hidetrue
Pending Box
titleHere are some estimates from our test and production environments

Estimates?

...

Pro projectdoc Dokument ca 0,3 Sekunden. Nicht PD Dokumente sind nicht betroffen.

Beispiele:

1000 Dokumente = 300s = 5 Min

10.000 Dokumente = 3.000s = 50 Min

100.000 Dokumente = 30.000s = 8:20 Stunden

This release has breaking changes. Therefore it is required to update extensions and doctype add-ons.

This version supports Confluence Server version 7.4.14 to 7.16.x

.



Section
titleBreaking Changes


Content Marker
is-empty-textNo issues found

Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion IN ('5.0.0', '5.0.1', '5.0.2', '5.0.3', '5.0.4')) && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd


...