Docs.atlassian.com - any alternatives?

Jira Development
#1

I’ve raised this through the Developer Support Portal and brought it up at AppWeeks - but at this point I’m hoping somebody out there has some type of idea of other resources to get server related documentation.

It’s getting quite annoying frankly, but there is either a lot of documentation not being linked to - go to https://docs.atlassian.com/software/jira/docs/api/ - there’s nothing past Jira 7.6, but if you know where to link it’s there: https://docs.atlassian.com/software/jira/docs/api/7.9.0/

Or links are just giving 404’s - for example go to the latest aui docs ( https://docs.atlassian.com/aui/7.8.0/docs/inline-dialog.html ) and then try to navigate to the 7.0.1 version - https://docs.atlassian.com/aui/7.0.1/docs .

Does anyone have any suggestions for other resources that we should be looking at because this is getting frustrating.

5 Likes
#2

@daniel - that /index.html is cached and needs to be refreshed/invalidated. #silllyiknow

I’ll dig into what the heck is happening on the AUI docs. Not clear.

#3

Can the Confluence one also be uncached? https://docs.atlassian.com/atlassian-confluence/

And Bamboo…

They’re all stuck with the index of old versions. :frowning:

#4

Is the problem that creating a new space for each version of the documentation is a complex process and some pages get missed?

#5

@mdoar - In the spirit of Open Company, No Bullshit, it’s really a number of issues, where processes complexity is a subset. We’re in the process of addressing that issue by creating standard practices for writing, publishing, and managing documentation.

@daniel - I’ll file a ticket with the team to get those indexes refreshed (and see what can be done to get this done as part of the build / deploy process). The /latest path seems to be reliably pointing to the right place (because it’s a redirect that never got cached by CDN).

1 Like
#6

Regarding the 404 for AUI’s 7.0.1 documentation, that’s on me – seems it didn’t get pushed to the site.

Longer term, I want to remove documentation for the patch version of AUI entirely, so we would have just major.minor documentation. The APIs of our components never change in patch versions – only bug fixes occur in them – so in 99% of cases, the docs are exactly the same between patch versions. In the other 1% of cases, the “bug” was the documentation :stuck_out_tongue: