B
B
blabs2022-02-17 16:12:51
JIRA
blabs, 2022-02-17 16:12:51

How to add table data binding in Confluence with data on other pages?

We use Confluence to document backend services. We create separate pages with migrations, in which we prescribe the parameters of entities in a tabular form. Next, we create a page method on separate pages for each REST API, on which we describe what entity data we send in REQUEST and what we expect in RESPONSE

PROBLEM
When changing data on the migrations page in the table, we have to constantly update the data on other pages manually. And of course we miss something, the documentation becomes

unreliable . Does confluence have an "application" or a macro to solve the problem at hand?

Answer the question

In order to leave comments, you need to log in

3 answer(s)
A
Alexander Ivanov, 2022-02-18
@oshliaer

blabs , there is probably no clear answer. I would suggest that documentation should go to code in development and from code in maintenance. Those. in the end, first you have a TK that Confluence refers to (remaining the starting point), and then you have code with the proper set of comments and documents in the codebase itself, which Confluence refers to as a result of work, and the code refers to some publics (for example, additional description articles).
You can automate in this place until you lose your pulse. The main thing here is not to try for the sake of trying. Therefore, if I chose, I would stay with Google Docs at the level of introductory description and abstraction .
An example of problematic automation. Here is this pagehttps://oshliaer.github.io/qna?target=labs/apps-sc... is generated from Google Doc. And everything would be fine, but only at the beginning it was a small script for 5 lines in Apps Script, and now it is an application on Go, which sometimes you also want to contribute. How did this even happen!? I can’t say anymore, but the fact that these were big overestimated hopes for Google Docs is a fact. Those. you run the risk of running into the automation of what you do not need at all.
I would not prefer anything to Jire, but I would add REST documentation to OpenAPI with proposals for changes through git with reverse links to the public generated in Confluence. The advantage of this approach is the complete and total ready-made automation (tweak a couple of Docker configs) up to tests, type checking and cross-references. Please note that links must be general in nature. Or you just need to embed the repository files in the desired context of the article.
Whether this applies to your migration tasks is a separate question. Perhaps there are some incredible multi-steps that simply cannot be specified in the comments in the OpenAPI code. Then a more systematic approach is needed. Perhaps storing and linking a large number of parameters through Google Sheets (using them as a primary source) will somehow be justified.

A
Arty_Fact, 2022-02-18
@Arty_Fact

Pay attention to the Table Filter and Charts for Confluence macro , it has the ability to collect tables from different pages.

B
blabs, 2022-02-22
@theblabs

Official answer from support
I recommend having a look at the Page Properties and Page Properties Report macros in Confluence. They allow you to create a small table on a page with key and value pairs, which you can report in a larger table using the Report macro. You can watch the videos below by StiltSoft on how that works:
Reports in Confluence (3 Parts): Page Properties a...
alternatively, that same vendor offers an app on Marketplace that would allow you to include table excerpts. See Table Filter and Charts for Confluence . Read through their documentation to see how that app works: How to use Table Excerpt and Table Include Macros .

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question