Please add Forge documentation

Forge Forge Platform and Tools
, ,
1

I’ve just noticed https://developer.atlassian.com/changelog/#CHANGE-2561, but there is no documentation for this. Please do not treat the changelog as a form of documentation.

The change log points to the following documentation:

However, that page documents the extension interfaces as follows:

interface ExtensionData {
  [k: string]: any;
}

Please stop adding features without documentation! It does not help if Atlassian adds new features every day that are undocumented or have no clear contract.

I have posted about this same issue a couple of times, and this is just another example.

8 Likes
2

Hi tbinna,

Apologies for the confusion with the changelog. Different modules can have different contexts, so we document the extension context with the modules themselves. For example: https://developer.atlassian.com/platform/forge/manifest-reference/modules/confluence-content-action/#extension-context

I’ll make a note with the team to consider adding the affected modules to changelogs going forward where applicable.

Thanks!
Timothy

2 Likes
3

Thanks for the clarification, @TimothyVanDyke. Just one follow-up question: Is there a reason the Jira global page module does not expose the location attribute?

4

Hi @tbinna,

Thanks for bringing that to my attention - it appears to have been an oversight, the Jira global page module should indeed receive location from the context. The team will update the docs shortly.

Cheers,
Timothy