April 9, 2024

Confluence Navigator

This post is a work-in-progress. Comment if you are interested and want to see this finished soon.

Structuring and navigating in Confluence can be quite cumbersome, especially if you have multiple dimensions or categories in your knowledge base.

I share here some best practices and tools to leverage complex knowledge structures in Confluence.

Problem description

Confluence only offers a flat labeling structure.
It is especially a challenge for the Cloud version of Confluence to navigate within a knowledge base because in the Cloud version, you can not search - in the built-in Search interface - by multiple labels with an AND relationship. 

Categories in Confluence

To group labels within a category, you can make use of page properties.

For example, if you want to group pages related to the category "tool" you can use in each page a page property with the page-property-id=tool that looks like this:


Filtering by multiple Labels in Confluence

I have already shared for my Confluence Chrome extension, how you can work around the Confluence search limitation in respect of label intersection by using the Confluence REST API.

You can do the same from any GUI

Leveraging Confluence API

API command to get labels of a list of pages (defined by cql)

1. Run a search to get pages matching the cql
2. Loop over each page to get labels of the page

API command to get page properties of a list of pages (defined by cql)




rest/masterdetail/1.0/detailssummary/lines?pageSize=30&pageIndex=0&cql=${cql}&spaceKey=${spaceKey}&contentId=${contentId}

https://tdalon.atlassian.net/wiki/rest/masterdetail/1.0/detailssummary/lines?cql=label=tool&spaceKey=PMT&headings=label,expert


heading needs to be lower case. 
No idea how to extract specific property-> assume first is the right one


Front End for Confluence Navigator

Tag/ Label cloud
Multiselect labels
Display multiple categories as defined in a config json file.

Prototype

Code is available in GitHub https://github.com/tdalon/confluence_navigator 

No comments:

Post a Comment